- Home
- Decisão Valida Mais
Decisão Valida Mais
Última atualização: 11 de Fevereiro de 2026
Decisão Valida Mais
Last update: 11th February, 2026
Introdução
O Produto Decisão de Vendas Online Valida+ (com garantia) pertence a família de produto de Vendas Online, destinado para pedidos de alto risco é ofertado exclusivamente com garantia de Chargeback e utiliza as componentes: titularidade, autenticação multifatorial e device. D A API deste produto permite que os integradores enviem pedidos para análise. Através da API é possível enviar pedidos e consultar o status do pedido da análise da Serasa
Introdução
Para começar a utilizar nossos serviços é necessário conhecer nossas formas de integração e o que nossa plataforma oferece. Resumidamente, para o back-end oferecemos o consumo de nossas API's e no front-end integrações para o seu website, com snippet em JavaScript, e aplicativos mobile, com SDK’s para Android e iOS. Nesta seção você entenderá como está formatada nossas soluções, ambientes e formas de autenticação.
Operações API
API Operations
Autenticação do Token
Todas as requisições submetidas à nossa API devem ser realizadas através de um token de 2048 caracteres.
O token é gerado através de um usuário e senha que deve ser fornecido pela ClearSale.
Entre em contato com o seu consultor de vendas para maiores informações.
Na autenticação, além do token retornamos sua data de expiração. É necessário que contemple no seu desenvolvimento o gerenciamento da vida útil do token com base nessa data de expiração.
Para o recebimento desse dado é necessário que reserve um espaço de 2048 caracteres. Só gere um novo token após a expiração do seu token atual.
Requisição
POST https://api.clearsale.com.br/v1/authenticate HTTP/1.1
Content-Type: application/json
{
"name": "{Your User}",
"password": "{Your Password}"
}POST https://homologacao.clearsale.com.br/api/v1/authenticate HTTP/1.1
Content-Type: application/json
{
"name": "{Your User}",
"password": "{Your Password}"
}Resposta
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"Token": "{Token value}",
"ExpirationDate": "{Token expiration date}"
} Inclusão de Pedidos para análise de risco
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",
"b2bB2c": "B2C",
"itemValue": 10.00,
"totalValue": 15.00,
"numberOfInstallments": 1,
"ip": "192.168.0.1",
"isGift": false,
"giftMessage": "Message Example",
"observation": "Observation example",
"status": 0,
"origin": "Origin example",
"channelID": "Additional origin information",
"reservationDate": "2017-03-21T22:36:36.0000000",
"billing": {
"clientID": "Client123",
"type": 1,
"primaryDocument": "12345678910",
"secondaryDocument": "12345678",
"name": "Complete Client Name",
"birthDate": "1990-01-10T00:00:00.000",
"email": "email@email.com.br",
"gender": "M",
"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"
}
]
},
"shipping": {
"clientID": "Client123",
"type": 1,
"primaryDocument": "12345678910",
"secondaryDocument": "12345678",
"name": "Complete Client Name",
"birthDate": "1990-01-10T00:00:00.000",
"email": "email@email.com.br",
"gender": "M",
"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"
}
],
"deliveryTime": "2 dias úteis",
"price": 5.00
},
"payments": [{
"sequential": 1,
"date": "2017-03-21T22:36:53.0000000",
"value": 25.00,
"type": 1,
"installments": 1,
"card": {
"number": "123456xxxxxx1234",
"hash": "12345678945612301234569874563210",
"bin": "123456",
"end": "1234",
"type": 1,
"validityDate": "02/2021",
"ownerName": "Owner Card Name",
"document": "12345678910",
"nsu": "12345"
},
"address": {
"street": "Street name example",
"number": "10",
"additionalInformation": "Additional information",
"county": "County Example",
"city": "City Example",
"state": "SP",
"zipcode": "12345678",
"country": "Brasil",
"reference": "Address reference example"
}
}
],
"items": [{
"code": "Item Code",
"name": "Item description",
"value": 10.00,
"amount": 1,
"categoryID": 1,
"categoryName": "Item category name",
"isGift": true,
"sellerName": "Seller Name",
"sellerDocument": "12345678910123",
"isMarketPlace": "true",
"sellerSegment": "Eletronicos" }
],
"passengers": [{
"name": "Passanger name",
"companyMileCard": "Company Name",
"mileCard": "123456789",
"identificationType": 1,
"identificationNumber": "123456789",
"gender": "M",
"birthdate": "1990-01-10T00:00:00.000",
"cpf": "12345678910"
}
],
"connections": [{
"company": "JJ",
"identificationNumber": 12345,
"date": "2017-10-10T00:00:00.000",
"seatClass": "Seat Class",
"origin": "GRU",
"destination": "LHR",
"boarding": "2017-10-10T00:00:00.000",
"arriving": "2017-10-10T00:00:00.000",
"fareClass": "First Class"
}
]
}
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",
"b2bB2c": "B2C",
"itemValue": 10.00,
"totalValue": 15.00,
"numberOfInstallments": 1,
"ip": "192.168.0.1",
"isGift": false,
"giftMessage": "Message Example",
"observation": "Observation example",
"status": 0,
"origin": "Origin example",
"channelID": "Additional origin information",
"reservationDate": "2017-03-21T22:36:36.0000000",
"billing": {
"clientID": "Client123",
"type": 1,
"primaryDocument": "12345678910",
"secondaryDocument": "12345678",
"name": "Complete Client Name",
"birthDate": "1990-01-10T00:00:00.000",
"email": "email@email.com.br",
"gender": "M",
"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"
}
]
},
"shipping": {
"clientID": "Client123",
"type": 1,
"primaryDocument": "12345678910",
"secondaryDocument": "12345678",
"name": "Complete Client Name",
"birthDate": "1990-01-10T00:00:00.000",
"email": "email@email.com.br",
"gender": "M",
"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"
}
],
"deliveryTime": "2 dias úteis",
"price": 5.00
},
"payments": [{
"sequential": 1,
"date": "2017-03-21T22:36:53.0000000",
"value": 25.00,
"type": 1,
"installments": 1,
"card": {
"number": "123456xxxxxx1234",
"hash": "12345678945612301234569874563210",
"bin": "123456",
"end": "1234",
"type": 1,
"validityDate": "02/2021",
"ownerName": "Owner Card Name",
"document": "12345678910",
"nsu": "12345"
},
"address": {
"street": "Street name example",
"number": "10",
"additionalInformation": "Additional information",
"county": "County Example",
"city": "City Example",
"state": "SP",
"zipcode": "12345678",
"country": "Brasil",
"reference": "Address reference example"
}
}
],
"items": [{
"code": "Item Code",
"name": "Item description",
"value": 10.00,
"amount": 1,
"categoryID": 1,
"categoryName": "Item category name",
"isGift": true,
"sellerName": "Seller Name",
"sellerDocument": "12345678910123",
"isMarketPlace": "true",
"sellerSegment": "Eletronicos" }
],
"passengers": [{
"name": "Passanger name",
"companyMileCard": "Company Name",
"mileCard": "123456789",
"identificationType": 1,
"identificationNumber": "123456789",
"gender": "M",
"birthdate": "1990-01-10T00:00:00.000",
"cpf": "12345678910"
}
],
"connections": [{
"company": "JJ",
"identificationNumber": 12345,
"date": "2017-10-10T00:00:00.000",
"seatClass": "Seat Class",
"origin": "GRU",
"destination": "LHR",
"boarding": "2017-10-10T00:00:00.000",
"arriving": "2017-10-10T00:00:00.000",
"fareClass": "First Class"
}
]
}
Resposta
Content-Type: application/json
Request-ID: 12J6-11B3-11A7-93C0
{
"packageID": "4825dc1d-5246-45d3-ba32-d2de9bbff478",
"orders": [
{
"code": "{CODIGO_DO_MEU_PEDIDO}",
"status": "APA",
"score": 99.99,
"fila": "Nome da Fila aplicada para o pedido"
}
]
}Token Authentication
All sent requests must be realize through a 2048 char token.
A token is generate through a user login and a password that are sent by ClearSale.
Please contact your sales consultant for more information.
During the authentication, the expiration date is sent. It is necessary that you consider in your development the management of the useful life of the token based on it expiration date.
To receive this data, it is necessary to reserve a space of 2048 characters. Only generate a new token after your current token has expired.
Request
POST https://apix.clearsale.com.br/authenticate
Content-Type: application/json
{
"name": "{Your User}",
"password": "{Your Password}"
}POST https://homologapix.clearsale.com.br/authenticate
Content-Type: application/json
{
"name": "{Your User}",
"password": "{Your Password}"
}Response
200 OK
Content-Type: application/json; charset=utf-8
{
"Token": "{Token value}",
"ExpirationDate": "{Token expiration date}"
} Notificação de alteração de status
Sempre que operação de inclusão de pedidos (item anterior) retornar o status “PEN” será disparado para o cliente final uma notificação de validação de duplo fator de autenticação (WhatsApp ou SMS).
Para esses casos haverá uma finalização de risco de forma assíncrona após o status PEN e sempre que essa finalização ocorrer uma notificação será enviada para uma URL que deverá ser implementada no lado do integrador.
A URL deverá ser capaz de interpretar a requisição de notificação de acordo com o exemplo abaixo:
POST
{URL_DO_INTEGRADOR}
REQUEST HEADER
Content-Type: application/json
REQUEST BODY
{
"code": "{CÓDIGO_TRANSACTION_ID}",
"date": "2016-01-01T10:30:00.9931909-02:00",
"type": "status"
}
Os valores de status e score da finalização assíncrona não serão informados na notificação, portanto, após isso será necessário que o integrador consuma a API consulta de status descrito no item seguinte para recebimento dessas informações.
Importante: Se a URL do integrador retornar qualquer status http diferente de 200, o sistema da ClearSale irá tentar notificar novamente para o pedido.
Assim que a URL for desenvolvida é necessário que envie o endereço a equipe de integração através do e-mail integracao@clear.sale para que essa URL seja configurada na base da Clearsale.
Search for Backoffice
Request
POST https://api-buychecker.clearsale.com.br/v1/transactions/backoffice/search
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
"cardFirstSix": "123456",
"cardLastFour": "1234",
"transactionAmount": "100.56",
"transactionDateTime": "2017-03-22T13:38:59.9894222",
"cardAcceptorName": "cardAcceptorNameExample",
"transactionId": "123456",
"acquirerReferenceNumber": "20292029202920292029001",
"issuerAuthorizationCode": "123456"
}POST https://api-buychecker-hml.clearsale.com.br/v1/transactions/backoffice/search
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
"cardFirstSix": "123456",
"cardLastFour": "1234",
"transactionAmount": "100.56",
"transactionDateTime": "2017-03-22T13:38:59.9894222",
"cardAcceptorName": "cardAcceptorNameExample",
"transactionId": "123456",
"acquirerReferenceNumber": "20292029202920292029001",
"issuerAuthorizationCode": "123456"
}Response
Content-Type: application/json
{
"merchantName": "merchantNameExample",
"date": "2017-03-22T13:38:59.9894222",
"amount": 100.52,
"billing": {
"billingName": "billingNameExample",
"address":{
"street": "streetExample",
"number": "11",
"city": "cityExample",
"postalCode": "24452001",
"countrySubdivisionCode": "CA",
"neighborhood": "neighborhoodExample"
},
"email": "emailExample@gmail.com",
"phone": "21999999999"
},
"purchase": {
"receiver": "receiverExample",
"email": "emailExample@gmail.com",
"shippingAddress": {
"street": "streetExample",
"number": "11",
"city": "cityExample",
"postalCode": "24452001",
"countrySubdivisionCode": "CA",
"neighborhood": "neighborhoodExample"
},
"items":[{
"description": "descriptionExample",
"amount": 100.52,
"quantity": 1
}]
}
}Consulta de status
Request
GET https://api.clearsale.com.br/v1/orders/{CODIGO_DO_MEU_PEDIDO}/status
REQUEST HEADER
Accept: application/json
Authorization: Bearer {TOKEN}
REQUEST BODY
Vazio
GET https://homologacao.clearsale.com.br/api/v1/orders/{CODIGO_DO_MEU_PEDIDO}/status
REQUEST HEADER
Accept: application/json
Authorization: Bearer {TOKEN}
REQUEST BODY
Vazio
Response
RESPONSE HEADER
Content-Type: application/json
Request-ID: 12J6-11B3-11A7-93C0
RESPONSE BODY
{
"code": "{CODIGO_DO_MEU_PEDIDO}",
"status": "APA",
"score": 99.99
}
Search for Apps
Request
POST https://api-buychecker.clearsale.com.br/v1/transactions/search
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
"cardFirstSix": "123456",
"cardLastFour": "1234",
"TransactionAmount": "100.56",
"TransactionDateTime": "2017-03-22T13:38:59.9894222",
"CardAcceptorName": "CardAcceptorNameExample",
"TransactionId": "123456",
"AcquirerReferenceNumber": "20292029202920292029001",
"IssuerAuthorizationCode": "123456"
}POST https://api-buychecker-hml.clearsale.com.br/v1/transactions/search
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
"cardFirstSix": "123456",
"cardLastFour": "1234",
"TransactionAmount": "100.56",
"TransactionDateTime": "2017-03-22T13:38:59.9894222",
"CardAcceptorName": "CardAcceptorNameExample",
"TransactionId": "123456",
"AcquirerReferenceNumber": "20292029202920292029001",
"IssuerAuthorizationCode": "123456"
}Response
Content-Type: application/json
{
"merchantName": "merchantNameExample",
"date": "2017-03-22T13:38:59.9894222",
"amount": 100.52,
"items":[{
"description": "descriptionExample",
"amount": 100.52,
"quantity": 1
}]
}
}Marcação de chargeback
A marcação de Chargeback é indispensável para calibrarmos a assertividade da nossa análise de risco.
Mais informações: Chargeback ClearSale: importância e como notificar
Request
POST https://api.clearsale.com.br}/v2/chargeback
REQUEST HEADER
Content-Type: application/json
Authorization: Bearer {TOKEN}
REQUEST BODY (ver descrição e obrigatoriedade dos campos)
{
"code": "{Codigo do pedido}",
"message": "Mensagem de exemplo",
"chargebackStatus": 1,
"chargebackDateUTC": "2020-01-17T00:00:00",
"reasonCode": "{Código do motivo da solicitação de chargeback}",
"disputeReason": 1,
"bin":"123456",
"pan":"123456",
"cardBrandId": 3,
"cardBrand":"VISA",
"disputeValue": 100.00,
"cardOwnerName":"{Nome do Titular do Cartão de Crédito}",
"shippingStatus":0,
"nsu": "{Número de identificação da operação de venda realizada}",
"tid": "{Transaction ID da venda realizada}",
"psp": "{Número de identificação da disputa}"
}
POST https://homologacao.clearsale.com.br/api}/v2/chargeback
REQUEST HEADER
Content-Type: application/json
Authorization: Bearer {TOKEN}
REQUEST BODY (ver descrição e obrigatoriedade dos campos)
{
"code": "{Codigo do pedido}",
"message": "Mensagem de exemplo",
"chargebackStatus": 1,
"chargebackDateUTC": "2020-01-17T00:00:00",
"reasonCode": "{Código do motivo da solicitação de chargeback}",
"disputeReason": 1,
"bin":"123456",
"pan":"123456",
"cardBrandId": 3,
"cardBrand":"VISA",
"disputeValue": 100.00,
"cardOwnerName":"{Nome do Titular do Cartão de Crédito}",
"shippingStatus":0,
"nsu": "{Número de identificação da operação de venda realizada}",
"tid": "{Transaction ID da venda realizada}",
"psp": "{Número de identificação da disputa}"
}
Response
RESPONSE HEADER
Content-Type: application/json
Request-ID: 12J6-11B3-11A7-93C0
RESPONSE BODY
[
{
"code": "{CODIGO_DO_MEU_PEDIDO}",
"status": “Chargeback done”
}
]
Search for Apps
Request
POST https://api-buychecker.clearsale.com.br/v1/transactions/search
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
"cardFirstSix": "123456",
"cardLastFour": "1234",
"TransactionAmount": "100.56",
"TransactionDateTime": "2017-03-22T13:38:59.9894222",
"CardAcceptorName": "CardAcceptorNameExample",
"TransactionId": "123456",
"AcquirerReferenceNumber": "20292029202920292029001",
"IssuerAuthorizationCode": "123456"
}POST https://api-buychecker-hml.clearsale.com.br/v1/transactions/search
Content-Type: application/json
Authorization: Bearer {TOKEN}
{
"cardFirstSix": "123456",
"cardLastFour": "1234",
"TransactionAmount": "100.56",
"TransactionDateTime": "2017-03-22T13:38:59.9894222",
"CardAcceptorName": "CardAcceptorNameExample",
"TransactionId": "123456",
"AcquirerReferenceNumber": "20292029202920292029001",
"IssuerAuthorizationCode": "123456"
}Response
Content-Type: application/json
{
"merchantName": "merchantNameExample",
"date": "2017-03-22T13:38:59.9894222",
"amount": 100.52,
"items":[{
"description": "descriptionExample",
"amount": 100.52,
"quantity": 1
}]
}
}Tabelas código e descrição
Appendix
Tipo de Telefone (billing/shipping.phone.type)
| Código | Descrição |
|---|---|
| 0 | Não definido |
| 1 | Residencial |
| 2 | Comercial |
| 3 | Recados |
| 4 | Cobrança |
| 5 | Temporário |
| 6 | Celular |
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
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 |
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
Tipo pessoa (billing/shipping.type)
| Código | Descrição |
|---|---|
| 1 | Pessoa Física |
| 2 | Pessoa Jurídica |
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
Tipo de sexo (billing/shipping.gender)
| Código | Descrição |
|---|---|
| M | Masculino |
| F | Feminino |
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
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 |
| 9 | Dinheiro |
| 10 | Financiamento |
| 12 | Cupom |
| 16 | VALE |
| 19 | Cartão de Débito |
| 23 | Vale Alimentação |
| 27 | PIX |
| 28 | Cashback |
| 32 | Saldo Programa de Pontos |
| 1041 | Cartão Presente Virtual |
| 4011 | Cartão de Débito/Transferência Eletrônica (CD) |
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
Bandeira do cartão de crédito (card.type)
| Código | Descrição |
|---|---|
| 1 | Diners Club |
| 2 | MasterCard |
| 3 | Visa |
| 4 | Outros Cartões |
| 5 | American Express |
| 6 | HiperCard |
| 7 | Cartão Aura |
| 10 | Cartão Elo |
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
Lista de Status Possíveis
| Status | Descrição |
|---|---|
| APA | (Aprovação Automática) – Pedido foi aprovado automaticamente segundo parâmetros definidos na regra de aprovação automática |
| PEN | (Análise Pendente) – Pedido está em fila de análise aguardando resposta de segundo fator de autenticação (MFA) |
| INC | (Análise Inconclusiva) – Resultado da análise de risco automática ou segundo fator de autenticação (MFA) foi inconclusivo |
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
Lista de Status de Entrada
Atenção: Ao enviar o status no pedido é importante ressaltar que este pedido será incluso como histórico e não será analisado pela ClearSale. Somente os pedidos que forem enviados com o status “0” – NVO ou que não tiverem o status definido que serão analisados pela ClearSale.
| Código | Sigla de Retorno API | Descrição |
|---|---|---|
| 0 | - | Novo (será analisado pela clearsale) |
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
Descrição de Campos
Fields Description
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 do pedido | String | 150 | S | |
| b2bB2c | Tipo do ecommerce | String | 3 | N |
| itemValue | Valor Total dos Itens | Decimal | 20,4 | N |
| totalValue | Valor Total do Pedido (Itens + Frete + Juros) | Decimal | 20,4 | S |
| numberOfInstallments | Quantidade de Parcelas | Integer | - | N |
| ip | IP Dispositivo do Pedido | String | 50 | N |
| isGift | Identifica se o pedido é presente | Boolean | - | N |
| giftMessage | Mensagem de Presente | String | 8000 | N |
| observation | Observação livre | String | 8000 | N |
| status | Status do Pedido | Integer | - | N |
| origin | Canal de Origem (TELEVENDAS, WEBSITE, APP, etc) | String | 150 | N |
| channelID | Canal de origem complementar (ANDROID, IOS, etc) | String | 150 | N |
| reservationDate | Data do Primeiro Voo do Pedido (aéreas) | Datetime | - | N |
| billing | Dados de cobrança | billing | - | S |
| shipping | Dados de entrega | shipping | - | N |
| payments | Dados de pagamento | Array<payment> | - | S |
| items | Itens | Array<item> | - | N |
| passengers | Passageiros | Array<passenger> | - | N |
| connections | Conexões | Array<connection> | - | N |
Object RequestDetail
| Property | Description | Type | Size | Mandatory |
|---|---|---|---|---|
| CardFirstSix | First six digits of the card | String | 6 | Y |
| CardLastFour | Last four digits of the card | String | 4 | Y |
| TransactionAmount | Transaction amount | Decimal | Y | |
| TransactionDateTime | Purchase date | DateTime | Y | |
| CardAcceptorName | Merchant 'doing business as' name | String | Y | |
| TransactionId | Transaction ID | String | N | |
| AcquirerReferenceNumber | Acquired reference number of the transaction | String | 23 | Y |
| IssuerAuthorizationCode | Issuer authorization code | String | 6 | Y |
Objeto Billing
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
| clientID | Código do cliente | String | 50 | N |
| type | Pessoa Física ou Jurídica | Integer | - | S |
| primaryDocument | CPF ou CNPJ | String | 100 | S |
| secondaryDocument | RG ou Inscrição Estadual | String | 100 | N |
| name | Nome do cliente | String | 500 | S |
| birthDate | Data de Nascimento | Datetime | - | N |
| String | 150 | N | ||
| gender | Sexo | String | 1 | N |
| address | Endereço | address | - | N |
| phones | Telefones | Array<phone> | - | S |
Object TransactionDetail
| Property | Description | Type |
|---|---|---|
| MerchantName | Merchant name | String |
| Date | Purchase date | DateTime |
| Amount | Purchase amount | decimal |
| Email registred in the purchase | String | |
| Phone | Phone number registred in the purchase | String |
| Billing | Object Billing | Billing |
| Purchase | Object Purchase | Purchase |
Objeto Shipping
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
| clientID | Código do cliente | String | 50 | N |
| type | Pessoa Física ou Jurídica | Integer | - | S |
| primaryDocument | CPF ou CNPJ | String | 100 | S |
| secondaryDocument | RG ou Inscrição Estadual | String | 100 | N |
| name | Nome do cliente | String | 500 | S |
| birthDate | Data de Nascimento | Datetime | - | N |
| String | 150 | N | ||
| gender | Sexo | String | 1 | N |
| address | Endereço | address | - | S |
| phones | Telefones | Array<phone> | - | S |
| deliveryTime | Prazo de Entrega | String | 50 | N |
| price | Valor do Frete | Decimal | 20,4 | N |
Importante: Se em sua regra de negócio existir entrega física, os dados de entrega (shipping) deverão ser informados.
Object Address
| Property | Description | Type |
|---|---|---|
| Street | Street name | String |
| Number | Residence number | String |
| City | City | String |
| PostalCode | Postal Code | String |
| CountrySubdivisionCode | State identification code | String |
| Neighborhood | Neighborhood | String |
Objeto Payments
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
| sequential | Sequência de realização do pagamento | Integer | - | N |
| date | Data do pagamento | Datetime | - | N |
| value | Valor cobrado neste pagamento | Decimal | 20,4 | N |
| type | Tipo de Pagamento | Integer | - | S |
| installments | Quantidade de Parcelas | Integer | - | N |
| interestRate | Taxa de Juros | Decimal | 4,2 | N |
| interestValue | Valor dos Juros | Decimal | 20,4 | N |
| currency | Código da moeda | Integer | - | N |
| voucherOrderOrigin | ID do pedido que gerou vale troca | String | 50 | N |
| address | Endereço de pagamento | paymentAddress | - | N |
| card | Cartão | card | - | S |
Object Billing
| Property | Description | Type |
|---|---|---|
| BillingName | Cardholder name | String |
| Cardholder e-mail | String | |
| Phone | Cardholder phone number | String |
| Address | Object Address | Address |
Objeto Items
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
| code | Código do Produto | String | 50 | N |
| name | Nome do Produto | String | 150 | S |
| value | Valor Unitário | Decimal | 20,4 | N |
| amount | Quantidade | Integer | - | N |
| categoryID | Código da Categoria do Produto | Integer | - | N |
| categoryName | Nome da Categoria do Produto | String | 200 | N |
| isGift | Identifica se o item é um presente (true ou false) | Boolean | - | N |
| sellerName | Nome do marketplace | String | 200 | N |
| sellerDocument | CNPJ do seller/parceiro | String | 14 | N |
| isMarketPlace | Item vendido pelo Marketplace (true ou false) | String | 5 | N |
| sellerSegment | Segmento do seller/parceiro | String | 200 | N |
| shippingCompany | Transportadora do item | String | 200 | N |
Importante: Em caso de empresas de passagens aéreas os dados de item não são obrigatórios.
O envio de dados de item não são obrigatórios, porém se houver envio, ao menos o nome do produto precisa ser informado.
Object Purchase
| Property | Description | Type |
|---|---|---|
| Receiver | Recipient name | String |
| Recipient email | String | |
| Address | Object Address | Address |
Objeto Passengers
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
| name | Nome do Passageiro | String | 100 | S |
| companyMileCard | Companhia de Milhagem (Fidelidade) | String | 50 | N |
| mileCard | Cartão de Milhagem (Fidelidade) | String | 50 | N |
| identificationType | Tipo de Documento de Identificação | Integer | - | N |
| identificationNumber | Número do Documento | String | 50 | N |
| gender | Sexo do Passageiro | String | 2 | N |
| birthdate | Data de nascimento | Datetime | - | N |
| cpf | CPF do Passageiro | String | 50 | N |
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
Objeto Connections
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
| company | Nome da Companhia Aérea | String | 50 | N |
| identificationNumber | Número do Voo | Integer | - | N |
| date | Data do Voo | Datetime | - | S |
| seatClass | Classe do Assento | String | 10 | N |
| origin | Origem | String | 5 | S |
| destination | Destino | String | 5 | S |
| boarding | Data de Embarque | Datetime | - | S |
| arriving | Data de Desembarque | Datetime | - | S |
| fareClass | Classe Tarifária | String | 25 | N |
Importante: Os objetos passengers e connections são utilizados somente em empresas de passagens aéreas e reservas. 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.
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
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 |
| additionallnformation | 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.
Se em sua regra de negócio existir a entrega física de produtos, os dados de entrega (shipping), incluindo os dados do endereço (shipping.address), deverão ser informados.
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
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.
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
Objeto PaymentAddress
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
| street | Nome do logradouro | String | 200 | N |
| number | Número do Endereço | String | 15 | N |
| additionalInformation | Complemento do Endereço | String | 250 | N |
| county | Bairro do Endereço | String | 150 | N |
| city | Cidade do Endereço | String | 150 | N |
| state | Sigla do Estado do Endereço – UF | String | 2 | N |
| country | País do Endereço | String | 150 | N |
| zipcode | CEP do Endereço | String | 10 | N |
| reference | Referência do Endereço | String | 250 | N |
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
Objeto Card
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
| number | Número do Cartão | String | 200 | N |
| hash | Hash do número do cartão | String | 128 | N |
| bin | Número do BIN do Cartão | String | 6 | S |
| end | 4 últimos dígitos do número do cartão | String | 4 | S |
| type | Bandeira do Cartão | Integer | - | N |
| validityDate | Data da Expiração | String | 50 | N |
| ownerName | Nome de Cobrança | String | 150 | S |
| document | Documento da Pessoa de Cobrança | String | 100 | N |
| nsu | Número identificador único de uma transação de cartão | String | 50 | N |
Obs: Os dados do cartão são obrigatórios e devem ser enviados somente quando a forma de pagamento do pedido for cartão de crédito.
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
Descrição de campos do json da Marcação de Chargeback
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
| code | ID do pedido (mesmo valor enviado anteriormente na propriedade "code" do JSON de análise de risco) | String | 50 | S |
| message | Texto de mensagem livre | String | 100 | N |
| chargebackStatus |
Status do chargeback: 0 – "Pré-Chargeback" 1 – "Débito de Chargeback" (valor padrão) |
Integer | - | N |
| chargebackDateUTC | Data da notificação de chargeback pela adquirente | Datetime | - | S |
| reasonCode | Código do motivo da solicitação de chargeback | String | 100 | N |
| disputeReason |
Motivo da disputa: 0 – "Desacordo Comercial" 1 – "Fraude" 2 – "Erro de Processamento" |
Integer | - | N |
| bin | 6 primeiros dígitos do cartão de crédito | String | 50 | N |
| pan | Campo alternativo ao bin do cartão (em alguns casos). 6 primeiros dígitos do cartão | String | 50 | N |
| cardBrandId | ID da bandeira do cartão ("Código") | Integer | - | N |
| cardBrand | Descrição da bandeira do cartão ("Descrição") | String | 50 | N |
| disputeValue | Valor do Chargeback | Decimal | 20,4 | N |
| cardOwnerName | Nome do Titular do Cartão | String | 200 | N |
| shippingStatus |
Status de entrega da compra: 0 – "Entregue" 1 – "Em rota – Entrega Barrada" 2 – "Em rota para Devolução" |
Integer | - | N |
| nsu | Número identificador único da operação de venda realizada | String | 200 | N |
| tid | ID da transação de venda realizada | String | 200 | N |
| psp | Número de identificação da disputa | String | 50 | N |
Object Items
| Property | Description | Type |
|---|---|---|
| Description | Item description | String |
| Amount | Item value | Decimal |
| Quantity | Quantity of items | Decimal |
Resolução de Problemas
Troubleshooting
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.
Ausência de usuário/senha
/StatusCode: 400 (Bad Request)
Content-Type: application/json
{
"Message": "The request is invalid.",
"ModelState": {
"< JPath_of_Property >": [
"The < Property > field is required."
]
}
}Campos obrigatórios não preenchidos
/StatusCode: 400 (Bad Request)
Content-Type: application/json
{
"Message": "The request is invalid.",
"ModelState": {
"": [
]
}
}
Usuário/senha incorretos
/HttpCode: 401 (Unauthorized)
Content-Type: text/plain
UserNotFoundToken expirado
/HttpCode: 403 (Forbidden)
Body: InvalidTokenPost com o pedido existente na base
/HttpCode: 400 (Bad request)
Body:
{
"Message": "The request is invalid.",
"ModelState": {
"existing-orders": [
"CODIGO_DO_PEDIDO"
]
}
}
Put sem pedido existente na base
/HttpCode: 400 (Bad request)
Body:
{
"Message": "The request is invalid.",
"ModelState": {
"orders-not-found": [
"CODIGO_DO_PEDIDO"
]
}
}
Post e Put com status não permitido
/HttpCode: 400 (Bad request)
Body:
{
"Message": "The request is invalid.",
"ModelState": {
"status-not-allowed": [
"status: "status_enviado" is not allowed"
]
}
}
Post e Put com JSON inválido
/HttpCode: 400 (Bad request)
Body:
{
"Message": "The request is invalid.",
"ModelState": {
"": [
"Não foi possível analisar o Json, erro na Propriedade: {nome_da_propriedade}, Posição: 12345"
]
}
}
Post ou Put vazio ou com JSON informado sem valores
/HttpCode: 400 (Bad request)
Body:
{
"Message": "The request is invalid.",
"ModelState": {
"": [
"Não foi possível analisar o Json, Json não possui valores"
]
}
}
Post ou Put onde o JSON é informado sem o valor “code”
/HttpCode: 400 (Bad request)
Body:
{
"Message": "The request is invalid.",
"ModelState": {
"[0]": [
"Required properties are missing from object: code. Line 1, position 1."
],
"": [
"Não foi possível analisar o Json, erro na Propriedade Code é um campo obrigatório."
]
}
}
Erro interno do servidor
/StatusCode: 500 (Internal Server Error)
Content-Type: application/json
{
"title": "Internal server error",
"status": 500,
"detail": "An internal error has ocurred. If it happens again, contact support.",
"exception": "< Details_of_error >"
}Missing username/password
/StatusCode: 400 (Bad Request)
Content-Type: application/json
{
"Message": "The request is invalid.",
"ModelState": {
"< JPath_of_Property >": [
"The < Property > field is required."
]
}
}Incorrect username/password
/HttpCode: 401 (Unauthorized)
Content-Type: text/plain
UserNotFoundInvalid token
/StatusCode: 401 (Unauthorized)Token expired
/StatusCode: 401 (Unauthorized)Required fields not filled
/StatusCode: 400 (Bad Request)
Content-Type: application/json
{
"title": "Request is not valid",
"status": 400,
"detail": "One or more invalid fields provided",
"invalidFields": [
{
"name": "< Field_Name >",
"reason": "'< Field_Name >' must be informed"
}
]
}Transaction not found
/StatusCode: 404 (Not Found)
Content-Type: application/json
{
"title": "No transaction found",
"status": 404,
"detail": "No transaction was found for the specified search parameters"
}Multiple transactions found
/StatusCode: 409 (Conflict)
Content-Type: application/json
{
"title": "Multiple transactions found",
"status": 409,
"detail": "More than one transaction was found for specified search parameters."
}Internal server error
/StatusCode: 500 (Internal Server Error)
Content-Type: application/json
{
"title": "Internal server error",
"status": 500,
"detail": "An internal error has ocurred. If it happens again, contact support.",
"exception": "< Details_of_error >"
}