Layout Transacional

Esses são os dados que solicitamos para criar um modelo transacional personalizado para você, a depender do tipo de transação as informações são diferentes, porém podem ser agregadas.

Lembrando que, quanto mais dados conseguir enviar desse layout, mais acurado e preciso ficará o score.

Caso identifique internamente informações relevantes para o modelo que não estejam presentes no layout, elas podem ser enviadas através do "extra_data".

Aqui está o arquivo contendo esse layout e para mais informações consulte a aba API, onde temos toda a documentação das nossas APIs disponíveis.

Pix	Ted	Boleto	Cartão	Campo	Descrição	Obrig.	Condição	Domínio	Tipo	Exemplo
Sim	Sim	Sim	Sim	date_fraud	data de identificação da fraude (campo usado na carga histórica)	não	terá informação apenas quando o campo flag_fraude for TRUE		date ou string (ANO-MES-DIA)	2021-05-22
Sim	Sim	Sim	Sim	flag_fraud	flag identificando se a transação é ou não uma fraude (campo usado na carga histórica)	sim	FALSE: não fraude TRUE: fraude		boolean	TRUE
Sim	Sim	Sim	Sim	fraud_type	segmento identificando a modalidade da fraude (campo usado na carga histórica)	não	terá informação apenas quando o campo flag_fraude for TRUE		string	golpe
Sim	Sim	Sim	Sim	transaction_final_status	status/decisão final da transação (campo usado na carga histórica)	sim		Exemplos: aprovada, reprovada, mesa de decisão cancelada, outro	string	aprovada
Sim	Sim	Sim	Sim	device_fingerprint	identificador único do dispositivo no sistema	não	não pode ter identificadores iguais para dispositivos diferentes		string	36004ba1725dfc57ff731cf770228c7e
Sim	Sim	Sim	Sim	device_vendor	fabricante do dispositivo	não		Exemplos: samsung, apple, motorola, lg	string	Google
Sim	Sim	Sim	Sim	device_browser	navegador usado na transação	não		Exemplos: google chrome, microsoft edge, opera, mozilla, firefox	string	firefox
Sim	Sim	Sim	Sim	device_category	categoria do dispositivo usado na transação	não		Exemplos: mobile, computador	string	MOBILE
Sim	Sim	Sim	Sim	device_ip	endereço IP do dispositivo usado na transação	condicional	campo obrigatório quando o objetivo for PLD		string	127.0.0.1
Sim	Sim	Sim	Sim	device_imei	número de identificação único e global do aparelho celular utilizado na transação	não	terá informação apenas quando device_category for mobile, e não pode ter identificadores iguais para celulares diferentes		string	123456789012345
Sim	Sim	Sim	Sim	transaction_id	identificador único da transação	sim	não pode ter identificadores iguais para transações diferentes		string	4b425c1c-a9e8-4f7e-b7e7-4cc201c3f798
Sim	Sim	Sim	Não	transaction_description	descrição da transação	não			string	Pay my apartment rent.
Sim	Sim	Sim	Sim	transaction_currency_code	código da moeda utilizada na transação	condicional	campo obrigatório quando o objetivo for PLD		string	EUR
Sim	Sim	Sim	Sim	transaction_amount_total	valor total da transação	sim			float	130.99
Não	Não	Sim	Sim	transaction_instalments	quantidade de parcelas	condicional	obrigatório caso transaction_channel seja cartão		int	10
Sim	Sim	Sim	Sim	transaction_datetime_request	data e hora que a transação foi feita	sim			Datetime ou string (ANO-MES-DIA HH:MM:SS)	2015-03-21T11:07:22.956087
Sim	Sim	Sim	Não	transaction_datetime_program	caso a transação tenha sido agendada, data do agendamento	não	terá informação apenas quando a transação for um agendamento		Datetime ou string (ANO-MES-DIA HH:MM:SS)	2015-03-21T11:07:22.956087
Não	Não	Não	Sim	transaction_acquirer	nome do adquirente	não			string	getnet.
Sim	Sim	Sim	Sim	transaction_channel	tipo de transação	sim		pix, ted, pagamento, cartão	string	pix
Sim	Sim	Sim	Sim	transaction_type	segmento do tipo da transação	condicional	obrigatório caso transaction_channel seja pix, ted ou cartão	transaction_channel pix ou ted: cash-in ou cash-out transaction_channel cartão: crédito ou débito transaction_channel pagamento: avulso ou carnê	string	cash-in
Sim	Sim	Sim	Sim	transaction_origin	origem da transação	sim		pos, online, atm, personal_service, qr_code	string	pos
Sim	Sim	Sim	Sim	transaction_location	localização com latitude e longitude no momento da transação	não			string	-22.41893856,-46.96661555
Sim	Sim	Sim	Sim	transaction_payer_id	identificador único do pagador no sistema	sim	não pode ter identificadores iguais para pagadores diferentes		string	4b425c1c-a9e8-4f7e-b7e7-4cc201c3f798
Sim	Sim	Sim	Sim	transaction_payer_registration_data_name	nome do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	Robin Williams
Sim	Sim	Sim	Sim	transaction_payer_registration_data_email	email do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	[email protected]
Sim	Sim	Sim	Sim	transaction_payer_registration_data_datetime_account_create	data e hora de criação da conta do pagador	não			Datetime ou string (ANO-MES-DIA HH:MM:SS)	2015-03-21T11:07:22.956087
Sim	Sim	Sim	Sim	transaction_payer_registration_data_phone_number	telefone do pagador	não			string	+5514912345678
Sim	Sim	Sim	Sim	transaction_payer_registration_data_birthdate	data de nascimento do pagador	condicional	campo obrigatório quando o objetivo for PLD		date ou string (ANO-MES-DIA)	1980-03-16
Sim	Sim	Sim	Sim	transaction_payer_registration_data_doc	número do documento do pagador	sim			string	12345678900
Sim	Sim	Sim	Sim	transaction_payer_registration_data_doc_type	tipo do documento do pagador	sim		CPF, CNPJ, passaporte	string	cpf
Sim	Sim	Sim	Sim	transaction_payer_registration_data_address_zip_code	código postal do endereço do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	55400-270
Sim	Sim	Sim	Sim	transaction_payer_registration_data_address_city	cidade do endereço do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	rio de janeiro
Sim	Sim	Sim	Sim	transaction_payer_registration_data_address_street_name	nome da rua do endereço do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	avenida copacabana
Sim	Sim	Sim	Sim	transaction_payer_registration_data_address_street_number	número do endereço do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	154-A
Sim	Sim	Sim	Sim	transaction_payer_registration_data_address_complement	complemento do endereço do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	behind shopping center
Sim	Sim	Sim	Sim	transaction_payer_registration_data_address_state	estado do endereço do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	rio de janeiro
Sim	Sim	Sim	Sim	transaction_payer_registration_data_address_country	país do endereço do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	BR
Sim	Sim	Sim	Sim	transaction_payer_banking_data_account_type	tipo da conta do pagador	não		CHECKING_ACCOUNT, SAVINGS_ACCOUNT	string	CHECKING_ACCOUNT
Sim	Sim	Sim	Sim	transaction_payer_banking_data_institution_name	instituição da conta do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	Bank etc...
Sim	Sim	Sim	Sim	transaction_payer_banking_data_bank_code	código da instituição da conta do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	001
Sim	Sim	Sim	Sim	transaction_payer_banking_data_branch_code	código da agência do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	1234
Sim	Sim	Sim	Sim	transaction_payer_banking_data_branch_name	nome da agência do pagador	condicional	campo obrigatório quando o objetivo for PLD		string	Branch 1234
Sim	Sim	Sim	Sim	transaction_payer_banking_data_account_id	número da conta do pagador	não			string	12345678
Sim	Sim	Sim	Sim	transaction_payer_banking_data_country	país da instituição da conta do pagador	não			string	BR
Sim	Sim	Sim	Sim	transaction_payer_banking_data_account_create_date	data de criação da conta do pagador	condicional	campo obrigatório quando o objetivo for PLD		date ou string (ANO-MES-DIA)	1980-03-16
Sim	Sim	Sim	Sim	transaction_payer_banking_data_account_last_update_date	data da última atualização da conta do pagador	condicional	campo obrigatório quando o objetivo for PLD		date ou string (ANO-MES-DIA)	1980-03-16
Sim	Não	Não	Não	transaction_payer_pix_key	tipos das chaves pix do pagador	não		telefone, cpf, cnpj, e-mail, chave aleatória	lista[string]	["008.632.554-70"]
Sim	Não	Não	Não	transaction_payer_pix_key_type	chaves pix do pagador	não			lista[string]	["CPF"]
Sim	Sim	Não	Não	transaction_receiver_id	identificador único do destinatário no sistema	sim	não pode ter identificadores iguais para destinatários diferentes		string	4b425c1c-a9e8-4f7e-b7e7-4cc201c3f798
Sim	Sim	Não	Não	transaction_receiver_registration_data_name	nome do destinatário	condicional	campo obrigatório quando o objetivo for PLD e a transação tiver um destinatário		string	Robin Williams
Sim	Sim	Não	Não	transaction_receiver_registration_data_email	email do destinatário	condicional	campo obrigatório quando o objetivo for PLD e a transação tiver um destinatário		string	[email protected]
Sim	Sim	Não	Não	transaction_receiver_registration_data_datetime_account_create	data e hora de criação da conta do destinatário	não			Datetime ou string (ANO-MES-DIA HH:MM:SS)	2015-03-21T11:07:22.956087
Sim	Sim	Não	Não	transaction_receiver_registration_data_phone_number	telefone do destinatário	não			string	+5514912345678
Sim	Sim	Não	Não	transaction_receiver_registration_data_birthdate	data de nascimento do destinatário	condicional	campo obrigatório quando o objetivo for PLD e a transação tiver um destinatário		Datetime ou string (ANO-MES-DIA)	1980-03-16
Sim	Sim	Não	Não	transaction_receiver_registration_data_doc	número do documento do destinatário	sim			string	12345678900
Sim	Sim	Não	Não	transaction_receiver_registration_data_doc_type	tipo do documento do destinatário	sim		CPF, CNPJ, passaporte	string	cpf
Sim	Sim	Não	Não	transaction_receiver_registration_data_address_zip_code	código postal do endereço do destinatário	condicional	campo obrigatório quando o objetivo for PLD e a transação tiver um destinatário		string	55400-270
Sim	Sim	Não	Não	transaction_receiver_registration_data_address_city	cidade do endereço do destinatário	condicional	campo obrigatório quando o objetivo for PLD e a transação tiver um destinatário		string	rio de janeiro
Sim	Sim	Não	Não	transaction_receiver_registration_data_address_street_name	nome da rua do endereço do destinatário	condicional	campo obrigatório quando o objetivo for PLD e a transação tiver um destinatário		string	avenida copacabana
Sim	Sim	Não	Não	transaction_receiver_registration_data_address_street_number	número do endereço do destinatário	condicional	campo obrigatório quando o objetivo for PLD e a transação tiver um destinatário		string	154-A
Sim	Sim	Não	Não	transaction_receiver_registration_data_address_complement	complemento do endereço do destinatário	condicional	campo obrigatório quando o objetivo for PLD e a transação tiver um destinatário		string	behind shopping center
Sim	Sim	Não	Não	transaction_receiver_registration_data_address_state	estado do endereço do destinatário	condicional	campo obrigatório quando o objetivo for PLD e a transação tiver um destinatário		string	rio de janeiro
Sim	Sim	Não	Não	transaction_receiver_registration_data_address_country	país do endereço do destinatário	condicional	campo obrigatório quando o objetivo for PLD e a transação tiver um destinatário		string	BR
Sim	Sim	Não	Não	transaction_receiver_banking_data_account_type	tipo da conta do destinatário	não		CHECKING_ACCOUNT, SAVINGS_ACCOUNT	string	CHECKING_ACCOUNT
Sim	Sim	Não	Não	transaction_receiver_banking_data_institution_name	instituição da conta do destinatário	condicional	campo obrigatório quando o objetivo for PLD, transação tiver um destinatário e a informação for conhecida		string	Bank etc...
Sim	Sim	Não	Não	transaction_receiver_banking_data_bank_code	código da instituição da conta do destinatário	condicional	campo obrigatório quando o objetivo for PLD, transação tiver um destinatário e a informação for conhecida		string	001
Sim	Sim	Não	Não	transaction_receiver_banking_data_branch_code	código da agência do destinatário	condicional	campo obrigatório quando o objetivo for PLD, transação tiver um destinatário e a informação for conhecida		string	1234
Sim	Sim	Não	Não	transaction_receiver_banking_data_branch_name	nome da agência do destinatário	condicional	campo obrigatório quando o objetivo for PLD, transação tiver um destinatário e a informação for conhecida		string	Branch 1234
Sim	Sim	Não	Não	transaction_receiver_banking_data_account_id	número da conta do destinatário	não			string	12345678
Sim	Sim	Não	Não	transaction_receiver_banking_data_country	país da instituição da conta do destinatário	não			string	BR
Sim	Sim	Não	Não	transaction_receiver_banking_data_account_create_date	data de criação da conta do destinatário	condicional	campo obrigatório quando o objetivo for PLD, transação tiver um destinatário e a informação for conhecida		date ou string (ANO-MES-DIA)	1980-03-16
Sim	Sim	Não	Não	transaction_receiver_banking_data_account_last_update_date	data da última atualização da conta do destinatário	condicional	campo obrigatório quando o objetivo for PLD, transação tiver um destinatário e a informação for conhecida		date ou string (ANO-MES-DIA)	1980-03-16
Sim	Não	Não	Não	transaction_receiver_pix_key	tipos de chaves pix do destinatário	não		telefone, cpf, cnpj, e-mail, chave aleatória	lista[string]	["CPF"]
Sim	Não	Não	Não	transaction_receiver_pix_key_type	chaves pix do destinatário	não			lista[string]	["008.632.554-70"]
Não	Não	Não	Sim	credit_card_id	identificador único do cartão de crédito no sistema	não	não pode ter identificadores iguais para cartões diferentes		string	4b425c1c-a9e8-4f7e-b7e7-4cc201c3f798
Não	Não	Não	Sim	credit_card_last_four	últimos quatro dígitos do cartão	não			string	0412
Não	Não	Não	Sim	credit_card_holder_name	nome presente no cartão	sim			string	Robin Williams
Não	Não	Não	Sim	credit_card_scheme	bandeira do cartão	não		Exemplos: mastercard, visa, elo, amex	string	mastercard
Não	Não	Não	Sim	credit_card_country	país do cartão	não			string	BR
Não	Não	Não	Sim	credit_card_bin	bin do cartão (primeiros seis dígitos)	não			string	591243
Não	Não	Não	Sim	credit_card_expiration_date	vencimento do cartão	não			string	2023-12
Não	Não	Sim	Não	boleto_our_number	nosso número do boleto	não			string	12345678
Não	Não	Sim	Não	boleto_bar_code	linha digitável do código de barras do boleto	sim			string	34191.09008 63571.277237 71830.000000 1 00000000000000
Não	Não	Sim	Não	boleto_expiration_date	data de vencimento do boleto	sim			Date ou string (ANO-MES-DIA)	2023-12-25
Não	Não	Sim	Não	boleto_expediction_date	data de expedição do boleto	não			Date ou string (ANO-MES-DIA)	2023-12-25
Não	Não	Sim	Não	boleto_beneficiary	beneficiário descrito no boleto	não			string	José Moura
Não	Não	Sim	Não	boleto_payer	pagador descrito no boleto	não			string	José Moura
Sim	Sim	Sim	Sim	order_items_item_id	id dos itens da compra	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		lista[string]	[123 , 555]
Sim	Sim	Sim	Sim	order_items_item_category	categoria dos itens da compra	não	campo específico para transações no ecommerce		lista[string]	[vestuário , eletro]
Sim	Sim	Sim	Sim	order_items_item_name	descritivo dos itens da compra	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		lista[string]	[calça jeans , televisão]
Sim	Sim	Sim	Sim	order_items_quantity	quantidade de cada item da compra	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		lista[int]	[1 , 1]
Sim	Sim	Sim	Sim	order_items_unit_price	preço unitário de cada item da compra	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		lista[float]	[109.90 , 4599.99]
Sim	Sim	Sim	Sim	order_delivery_zip_code	código postal do endereço de entrega	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		string	55400-270
Sim	Sim	Sim	Sim	order_delivery_city	cidade do endereço de entrega	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		string	rio de janeiro
Sim	Sim	Sim	Sim	order_delivery_street_name	nome da rua do endereço de entrega	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		string	avenida copacabana
Sim	Sim	Sim	Sim	order_delivery_street_number	número do endereço de entrega	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		string	154-A
Sim	Sim	Sim	Sim	order_delivery_complement	complemento do endereço de entrega	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		string	behind shopping center
Sim	Sim	Sim	Sim	order_delivery_state	estado do endereço de entrega	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		string	rio de janeiro
Sim	Sim	Sim	Sim	order_delivery_country	país do endereço de entrega	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		string	BR
Sim	Sim	Sim	Sim	order_delivery_value	valor do frete	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		float	25.12
Sim	Sim	Sim	Sim	order_delivery_company	empresa de transporte responsável pela entrega	condicional	campo específico para transações no ecommerce e obrigatório quando o objetivo for PLD		string	fedex
Sim	Sim	Sim	Sim	order_delivery_estimated_delivery_days	quantidade de dias estimados para a entrega	não	campo específico para transações no ecommerce		int	2
Sim	Sim	Sim	Sim	order_delivery_phone_number	telefone de entrega	não	campo específico para transações no ecommerce		string	+5514912345678
Sim	Sim	Sim	Sim	order_voucher_value	valor do voucher utilizado no pagamento	não	campo específico para transações no ecommerce		float	20
Sim	Sim	Sim	Sim	order_multiple_payment_methods	flag para identificar se houve mais de uma forma de pagamento	não	campo específico para transações no ecommerce	"FALSE: apenas uma forma de pagamento TRUE: mais de uma forma de pagamento"	boolean	TRUE
Sim	Sim	Sim	Sim	pos_id	código da loja física	condicional	obrigatório quando o objetivo for PLD		string	4b425c1c-a9e8-4f7e-b7e7-4cc201c3f798
Sim	Sim	Sim	Sim	pos_name	nome da loja física	condicional	obrigatório quando o objetivo for PLD		string	Loja física 123
Sim	Sim	Sim	Sim	pos_address_zip_code	código postal do endereço da loja física	condicional	obrigatório quando o objetivo for PLD		string	55400-270
Sim	Sim	Sim	Sim	pos_address_city	cidade do endereço da loja física	condicional	obrigatório quando o objetivo for PLD		string	rio de janeiro
Sim	Sim	Sim	Sim	pos_address_street_name	nome da rua do endereço da loja física	condicional	obrigatório quando o objetivo for PLD		string	avenida copacabana
Sim	Sim	Sim	Sim	pos_address_street_number	número do endereço da loja física	condicional	obrigatório quando o objetivo for PLD		string	154-A
Sim	Sim	Sim	Sim	pos_address_complement	complemento do endereço da loja física	condicional	obrigatório quando o objetivo for PLD		string	behind shopping center
Sim	Sim	Sim	Sim	pos_address_state	estado do endereço da loja física	condicional	obrigatório quando o objetivo for PLD		string	rio de janeiro
Sim	Sim	Sim	Sim	pos_address_country	país do endereço da loja física	condicional	obrigatório quando o objetivo for PLD		string	BR
Sim	Sim	Sim	Sim	customer_id	identificador único do cliente de cobrança	sim	campo específico para transações no ecommerce não pode ter identificadores iguais para pagadores diferentes		string	4b425c1c-a9e8-4f7e-b7e7-4cc201c3f798
Sim	Sim	Sim	Sim	customer_registration_data_name	nome do cliente de cobrança	não	campo específico para transações no ecommerce		string	Robin Williams
Sim	Sim	Sim	Sim	customer_registration_data_email	email do cliente de cobrança	não	campo específico para transações no ecommerce		string	[email protected]
Sim	Sim	Sim	Sim	customer_registration_data_datetime_account_create	data e hora de criação da conta do cliente de cobrança	não	campo específico para transações no ecommerce		Datetime ou string (ANO-MES-DIA HH:MM:SS)	2015-03-21T11:07:22.956087
Sim	Sim	Sim	Sim	customer_registration_data_phone_number	telefone do cliente de cobrança	não	campo específico para transações no ecommerce		Datetime ou string (ANO-MES-DIA HH:MM:SS)	+5514912345678
Sim	Sim	Sim	Sim	customer_registration_data_birthdate	data de nascimento do cliente de cobrança	não	campo específico para transações no ecommerce		date ou string (ANO-MES-DIA)	1980-03-16
Sim	Sim	Sim	Sim	customer_registration_data_doc	número do documento do cliente de cobrança	não	campo específico para transações no ecommerce		string	12345678900
Sim	Sim	Sim	Sim	customer_registration_data_doc_type	tipo do documento do cliente de cobrança	não	campo específico para transações no ecommerce	CPF, CNPJ, passaporte	string	cpf
Sim	Sim	Sim	Sim	customer_registration_data_address_zip_code	código postal do endereço de cobrança	não	campo específico para transações no ecommerce		string	55400-270
Sim	Sim	Sim	Sim	customer_registration_data_address_city	cidade do endereço de cobrança	não	campo específico para transações no ecommerce		string	rio de janeiro
Sim	Sim	Sim	Sim	customer_registration_data_address_street_name	nome da rua do endereço de cobrança	não	campo específico para transações no ecommerce		string	avenida copacabana
Sim	Sim	Sim	Sim	customer_registration_data_address_street_number	número do endereço de cobrança	não	campo específico para transações no ecommerce		string	154-A
Sim	Sim	Sim	Sim	customer_registration_data_address_complement	complemento do endereço de cobrança	não	campo específico para transações no ecommerce		string	behind shopping center
Sim	Sim	Sim	Sim	customer_registration_data_address_state	estado do endereço de cobrança	não	campo específico para transações no ecommerce		string	rio de janeiro
Sim	Sim	Sim	Sim	customer_registration_data_address_country	país do endereço de cobrança	não	campo específico para transações no ecommerce		string	BR
Sim	Sim	Sim	Sim	extradata(nome do campo)	qualquer campo que não conste no layout pode ser enviado através do extra_data	não			variável