Travel Fraud Radar | ClearSale Docs

Introdução

A API retorna informações úteis para que, em conjunto com a análise de score e demais fatores, seja tomada a melhor decisão sobre o pedido/proposta.

Operações API

Inclusão de Pedidos

Requisição

POST https://api.clearsale.com.br/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
	"code": "ORDER_EXAMPLE_2_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59.9894222",
	"email": "email@email.com.br",
	"totalValue": 15.00,
	"origin": "Origin example",
	"billing": {
		"primaryDocument": "12345678910",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
			"type": 1,
			"ddi": 55,
			"ddd": 11,
			"number": 33333333,
			"extension": "1111"
		}]
	},
	"payments": [{
		"value": 25.00,
		"type": 1,
		"installments": 1,
		"card": {
			"number": "123456xxxxxx1234",
			"bin": "123456",
			"end": "1234",
			"validityDate": "02/2021",
			"ownerName": "Owner Card Name"
		}
	}],
	"items": [{
		"name": "Item description",
		"value": 10.00,
		"amount": 1
	}],
	"passengers": [{
		"name": "Passanger name",
		"identificationType": 1,
		"identificationNumber": "123456789"
	}],
	"connections": [{
        "date": "2017-10-10T00:00:00.000",
		"origin": "GRU",
		"destination": "LHR",
		"boarding": "2017-10-10T00:00:00.000",
		"arriving": "2017-10-10T00:00:00.000"
	}]
}

POST https://homologacao.clearsale.com.br/api/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
	"code": "ORDER_EXAMPLE_2_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59.9894222",
	"email": "email@email.com.br",
	"totalValue": 15.00,
	"origin": "Origin example",
	"billing": {
		"primaryDocument": "12345678910",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00.000",
		"address": {
			"street": "Street name example",
			"number": "100",
			"additionalInformation": "Additional information example",
			"county": "County Example",
			"city": "City Example",
			"state": "SP",
			"zipcode": "12345678",
			"country": "Brasil",
			"reference": "Address reference example"
		},
		"phones": [{
			"type": 1,
			"ddi": 55,
			"ddd": 11,
			"number": 33333333,
			"extension": "1111"
		}]
	},
	"payments": [{
		"value": 25.00,
		"type": 1,
		"installments": 1,
		"card": {
			"number": "123456xxxxxx1234",
			"bin": "123456",
			"end": "1234",
			"validityDate": "02/2021",
			"ownerName": "Owner Card Name"
		}
	}],
	"items": [{
		"name": "Item description",
		"value": 10.00,
		"amount": 1
	}],
	"passengers": [{
		"name": "Passanger name",
		"identificationType": 1,
		"identificationNumber": "123456789"
	}],
	"connections": [{
        "date": "2017-10-10T00:00:00.000",
		"origin": "GRU",
		"destination": "LHR",
		"boarding": "2017-10-10T00:00:00.000",
		"arriving": "2017-10-10T00:00:00.000"
	}]
}

Resposta

                                Content-Type: application/json
Request-ID: 12J6-11B3-11A7-93C0
{
  "packageID": "4825dc1d-5246-45d3-ba32-d2de9bbff478",
  "orders": [
    {
      "code": "{CODIGO_DO_MEU_PEDIDO}",
      "status": "SCO",
      "score": 99.99
    }
  ]
}
                            

Lista de Diagnósticos

Requisição

GET https://api.clearsale.com.br/v1/orders/{code}/diagnostics
Accept: application/json
Authorization: Bearer {Token}

GET https://homologacao.clearsale.com.br/api/v1/orders/{code}/diagnostics 
Accept: application/json
Authorization: Bearer {Token}

Resposta

Request-ID: 12J6-11B3-11A7-93C0
Content-Type: application/json
{
    "code": "Cod_do_Pedido",
    "diagnostics": [
        {
            "name": "Cliente",
            "description": "Cliente já fez compras no mercado (CPF)",
            "id": 102
        },
        {
            "name": "Perfil",
            "description": "Nível de risco do Bin do Cartão = Alto",
            "id": 516
        },
        {
            "name": "Modelo Estatístico",
            "description": "UF origem CPF igual a UF de entrega ",
            "id": 516
        }
    ]
}

Resolução de problemas

Em todas as requisições realizadas será retornado uma chave no header chamada Request-ID, o valor desta chave conterá 19 caracteres, através de tal valor nosso suporte será capaz de capturar a sua transação e auxiliá-lo na resolução de algum problema.

Tabelas código e descrição

Tipo de telefone (billing.phone.type)

Código	Descrição
0	Não definido
1	Residencial
2	Comercial
3	Recados
4	Cobrança
5	Temporário
6	Celular

Tipo de identificação (passanger.identificationType)

Código	Descrição
1	CPF
2	CNPJ
3	RG
4	IE
5	Passaporte
6	CTPS
7	Título Eleitor

Tipo de pagamento (payment.type)

Código	Descrição
1	Cartão de Crédito
2	Boleto Bancário
3	Débito Bancário
4	Débito Bancário - Dinheiro
5	Débito Bancário - Cheque
6	Transferência Bancária
7	Sedex a cobrar
8	Cheque
9	Dinheiro
10	Financiamento
11	Fatura
12	Cupom
13	Multicheque
14	Outros
16	Vale
1041	Cartão Presente Virual
4011	Cartão de Débito / Transferência Eletrônica (CD)

Status de pagamento

Código	Descrição
PGA	Pedido Aprovado
PGR	Pedido Reprovado

Tipo pessoa (billing.type)

Código	Descrição
1	Pessoa Física
2	Pessoa Jurídica

Descrição de campos

Objeto order

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
code	Código do pedido	String	50	S
sessionID	Identificador único da sessão do usuário	String	128	S
date	Data do pedido	Datetime		S
email	Email do pedido	String	150	S
totalValue	Valor Total do Pedido	Decimal	20,4	S
origin	Origem	String	150	N
billing	Dados de cobrança	billing		S
payments	Dados de pagamento	Array<payment>		S
items	items	Array<item>		S
passengers	passengers	Array<passenger>		S
connections	connections	Array<connection>		S

Objeto billing

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
type	Pessoa Física ou Jurídica	Integer		S
primaryDocument	CPF ou CNPJ	String	100	S
name	Nome do cliente	String	500	S
birthDate	Data de Nascimento	Datetime		N
address	Endereço	address		S
phones	Telefones	Array<phone>		S

Objeto payments

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
value	Valor cobrado neste pagamento	Decimal	20,4	N
type	Tipo de Pagamento	Integer		S
installments	Quantidade de Parcelas	Integer		N
card	cartão	card		S

Objeto items

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
name	Nome do Produto	String	150	S
value	Valor Unitário	Decimal	20,4	N
amount	Quantidade	Integer		N

Importante: Em caso de empresas de passagens aéreas os dados de item não são obrigatórios.

Objeto passengers

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
name	Nome do Passageiro	String	100	S
identificationType	Tipo de Documento de Identificação	Integer		N
identificationNumber	Número do Documento	String	50	N

Objeto connections

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
date	Data do Voo	Datetime		S
origin	Origem	String	5	S
destination	Destino	String	5	S
boarding	Data de Embarque	Datetime		S
arriving	Data de Desembarque	Datetime		S

Importante: Os objetos passengers e connections são utilizados somente em empresas de passagens aéreas.

Caso não seja o seu caso, favor omitir essas propriedades no json de sua requisição.

No objeto connections informar somente os dados de origem e destino, não informar escalas e conexões.

Por exemplo:

Para um vôo de São Paulo (Guarulhos) para Londres, via New York (JFK), você irá informar apenas GRU-LHR, ao invés de GRU-JFK e JFK-LHR.

Objeto address

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
street	Nome do logradouro	String	200	S
number	Número do Endereço	String	15	S
additionalInformation	Complemento do Endereço	String	250	N
county	Bairro do Endereço	String	150	S
city	Cidade do Endereço	String	150	S
state	Sigla do Estado do Endereço - UF	String	2	S
country	País do Endereço	String	150	N
zipcode	CEP do Endereço	String	10	S
reference	Referência do Endereço	String	250	N

Importante: O envio do endereço não é obrigatório, porém caso tenha essa informação para envio, deverá respeitar a obrigatoriedade mínima dos campos informados como ‘S’.

Em caso de empresas de passagens aéreas o endereço de entrega não é obrigatório.

Objeto phones

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
type	Tipo de Telefone	Integer		S
ddi	DDI do Telefone	Integer	3	N
ddd	DDD do Telefone	Integer	2	S
number	Número do Telefone	Integer	9	S
extension	Ramal do Telefone	String	10	N

Importante: É obrigatório o envio de pelo menos 1 telefone.

Objeto card

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
number	Número do Cartão	String	200	N
bin	Número do BIN do Cartão	String	6	S
end	4 últimos digitos do número de cartão	String	4	S
validityDate	Data da Expiração	String	50	N
ownerName	Nome de Cobrança	String	150	S