Tickets - Tickets Garantido (Nova regras para ofertas garantidas)

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

Requisição

POST https://api.clearsale.com.br/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
[{
	"code": "ORDER_EXAMPLE_0_0_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59",
	"email": "email@email.com.br",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"ip": "192.168.0.1",
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"country": "Brasil",
	"sla": 60,
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@email.com.br",
		"login": "SocialNetworkLogin"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00",
		"email": "email@email.com.br",
		"gender": "M",
		"motherName": "Mother Name Example",
		"address": {
			"street": "Street name example",
			"number": "0",
			"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",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "0",
			"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"
		}],
		"deliveryType": "1",
		"price": 5.00
	},
	"payments": [{
		"sequential": 1,
		"date": "2017-03-21T22:36:53",
		"value": 80.00,
		"type": 1,
		"installments": 1,
		"interestRate": 0.00,
		"interestValue": 0.00,
		"card": {
			"number": "123456xxxxxx1234",
			"hash": "12345678945612301234569874563210",
			"bin": "123456",
			"end": "1234",
			"type": 1,
			"validityDate": "02/2021",
			"ownerName": "Owner Card Name",
			"document": "12345678910",
			"nsu": "12345"
		}
	}],
	"tickets": [{
		"convenienceFeeValue": 0.00,
		"quantityFull": 500,
		"quantityHalf": 250,
		"batch": 12345,
		"virtual": true,
		"event": {
			"id": "123456",
			"name": "Event name exeample",
			"local": "Event's place example",
			"date": "2017-03-21T22:36:53",
			"type": 1,
			"genre": "Music concert",
			"quantityTicketSale": 800,
			"quantityEventHouse": 2,
			"address": {
				"street": "Street name example",
				"number": "10",
				"county": "County Example",
				"city": "City Example",
				"state": "SP",
				"country": "Brasil",
				"zipcode": "12345678"
			}
		},
		"peoples": [{
			"name": "Name example",
			"legalDocument": "12345678910"
		}],
		"categories": [{
			"name": "Category name example",
			"quantity": 100,
			"value": 100.00
		}],
		"additionalInformations": [{
			"name": "Product name example",
			"quantity": 5,
			"value": 10.00
		}]
	}]
}]

POST https://homologacao.clearsale.com.br/api/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
[{
	"code": "ORDER_EXAMPLE_0_0_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59",
	"email": "email@email.com.br",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"ip": "192.168.0.1",
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"country": "Brasil",
	"sla": 60,
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@email.com.br",
		"login": "SocialNetworkLogin"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00",
		"email": "email@email.com.br",
		"gender": "M",
		"motherName": "Mother Name Example",
		"address": {
			"street": "Street name example",
			"number": "0",
			"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",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "0",
			"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"
		}],
		"deliveryType": "1",
		"price": 5.00
	},
	"payments": [{
		"sequential": 1,
		"date": "2017-03-21T22:36:53",
		"value": 80.00,
		"type": 1,
		"installments": 1,
		"interestRate": 0.00,
		"interestValue": 0.00,
		"card": {
			"number": "123456xxxxxx1234",
			"hash": "12345678945612301234569874563210",
			"bin": "123456",
			"end": "1234",
			"type": 1,
			"validityDate": "02/2021",
			"ownerName": "Owner Card Name",
			"document": "12345678910",
			"nsu": "12345"
		}
	}],
	"tickets": [{
		"convenienceFeeValue": 0.00,
		"quantityFull": 500,
		"quantityHalf": 250,
		"batch": 12345,
		"virtual": true,
		"event": {
			"id": "123456",
			"name": "Event name exeample",
			"local": "Event's place example",
			"date": "2017-03-21T22:36:53",
			"type": 1,
			"genre": "Music concert",
			"quantityTicketSale": 800,
			"quantityEventHouse": 2,
			"address": {
				"street": "Street name example",
				"number": "10",
				"county": "County Example",
				"city": "City Example",
				"state": "SP",
				"country": "Brasil",
				"zipcode": "12345678"
			}
		},
		"peoples": [{
			"name": "Name example",
			"legalDocument": "12345678910"
		}],
		"categories": [{
			"name": "Category name example",
			"quantity": 100,
			"value": 100.00
		}],
		"additionalInformations": [{
			"name": "Product name example",
			"quantity": 5,
			"value": 10.00
		}]
	}]
}]

Resposta

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

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://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}"
}

Response

            HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Token": "{Token value}",
  "ExpirationDate": "{Token expiration date}"
}     
        

Send orders

Request

POST https://api.clearsale.com.br/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
[{
	"code": "ORDER_EXAMPLE_0_0_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59",
	"email": "email@email.com.br",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"ip": "192.168.0.1",
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"country": "Brasil",
	"sla": 60,
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@email.com.br",
		"login": "SocialNetworkLogin"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00",
		"email": "email@email.com.br",
		"gender": "M",
		"motherName": "Mother Name Example",
		"address": {
			"street": "Street name example",
			"number": "0",
			"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",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "0",
			"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"
		}],
		"deliveryType": "1",
		"price": 5.00
	},
	"payments": [{
		"sequential": 1,
		"date": "2017-03-21T22:36:53",
		"value": 80.00,
		"type": 1,
		"installments": 1,
		"interestRate": 0.00,
		"interestValue": 0.00,
		"card": {
			"number": "123456xxxxxx1234",
			"hash": "12345678945612301234569874563210",
			"bin": "123456",
			"end": "1234",
			"type": 1,
			"validityDate": "02/2021",
			"ownerName": "Owner Card Name",
			"document": "12345678910",
			"nsu": "12345"
		}
	}],
	"tickets": [{
		"convenienceFeeValue": 0.00,
		"quantityFull": 500,
		"quantityHalf": 250,
		"batch": 12345,
		"virtual": true,
		"event": {
			"id": "123456",
			"name": "Event name exeample",
			"local": "Event's place example",
			"date": "2017-03-21T22:36:53",
			"type": 1,
			"genre": "Music concert",
			"quantityTicketSale": 800,
			"quantityEventHouse": 2,
			"address": {
				"street": "Street name example",
				"number": "10",
				"county": "County Example",
				"city": "City Example",
				"state": "SP",
				"country": "Brasil",
				"zipcode": "12345678"
			}
		},
		"peoples": [{
			"name": "Name example",
			"legalDocument": "12345678910"
		}],
		"categories": [{
			"name": "Category name example",
			"quantity": 100,
			"value": 100.00
		}],
		"additionalInformations": [{
			"name": "Product name example",
			"quantity": 5,
			"value": 10.00
		}]
	}]
}]

POST https://homologacao.clearsale.com.br/api/v1/orders/
Content-Type: application/json
Authorization: Bearer {TOKEN}
[{
	"code": "ORDER_EXAMPLE_0_0_0_1",
	"sessionID": "SessionIDValue",
	"date": "2017-03-22T13:38:59",
	"email": "email@email.com.br",
	"itemValue": 10.00,
	"totalValue": 15.00,
	"ip": "192.168.0.1",
	"giftMessage": "Message Example",
	"observation": "Observation example",
	"status": 0,
	"origin": "Origin example",
	"country": "Brasil",
	"sla": 60,
	"purchaseInformation": {
		"lastDateInsertedMail": "2015-03-01T02:40:00",
		"lastDateChangePassword": "2015-04-02T05:15:00",
		"lastDateChangePhone": "2015-05-03T10:45:00",
		"lastDateChangeMobilePhone": "2015-06-04T12:05:00",
		"lastDateInsertedAddress": "2015-07-05T15:25:00",
		"purchaseLogged": false,
		"email": "email@email.com.br",
		"login": "SocialNetworkLogin"
	},
	"billing": {
		"clientID": "Client123",
		"type": 1,
		"primaryDocument": "12345678910",
		"secondaryDocument": "12345678",
		"name": "Complete Client Name",
		"birthDate": "1990-01-10T00:00:00",
		"email": "email@email.com.br",
		"gender": "M",
		"motherName": "Mother Name Example",
		"address": {
			"street": "Street name example",
			"number": "0",
			"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",
		"email": "email@email.com.br",
		"gender": "M",
		"address": {
			"street": "Street name example",
			"number": "0",
			"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"
		}],
		"deliveryType": "1",
		"price": 5.00
	},
	"payments": [{
		"sequential": 1,
		"date": "2017-03-21T22:36:53",
		"value": 80.00,
		"type": 1,
		"installments": 1,
		"interestRate": 0.00,
		"interestValue": 0.00,
		"card": {
			"number": "123456xxxxxx1234",
			"hash": "12345678945612301234569874563210",
			"bin": "123456",
			"end": "1234",
			"type": 1,
			"validityDate": "02/2021",
			"ownerName": "Owner Card Name",
			"document": "12345678910",
			"nsu": "12345"
		}
	}],
	"tickets": [{
		"convenienceFeeValue": 0.00,
		"quantityFull": 500,
		"quantityHalf": 250,
		"batch": 12345,
		"virtual": true,
		"event": {
			"id": "123456",
			"name": "Event name exeample",
			"local": "Event's place example",
			"date": "2017-03-21T22:36:53",
			"type": 1,
			"genre": "Music concert",
			"quantityTicketSale": 800,
			"quantityEventHouse": 2,
			"address": {
				"street": "Street name example",
				"number": "10",
				"county": "County Example",
				"city": "City Example",
				"state": "SP",
				"country": "Brasil",
				"zipcode": "12345678"
			}
		},
		"peoples": [{
			"name": "Name example",
			"legalDocument": "12345678910"
		}],
		"categories": [{
			"name": "Category name example",
			"quantity": 100,
			"value": 100.00
		}],
		"additionalInformations": [{
			"name": "Product name example",
			"quantity": 5,
			"value": 10.00
		}]
	}]
}]

Response

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

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

ID	Description
0	Undefined
1	Home
2	Work
3	Messages
4	Billing Phone
5	Temporary
6	Mobile

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

ID	Description
1	Natural Person
2	Legal Person

Código	Descrição
M	Masculino
F	Feminino

ID	Description
M	Male
F	Female

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
19	Cartão de Débito
23	Vale Alimentação
27	PIX
28	Cashback
1041	Cartão Presente Virtual
4011	Cartão de Débito / Transferência Eletrônica (CD)

ID	Description
1	Credit Card
2	Bank Slip
3	Bank Debit
4	Bank Debit - Money
5	Bank Debit - Check
6	Bank Transfer
7	Sedex
8	Check
9	Money
10	Financing
11	Invoice
12	Coupon
13	Multicheque
14	Other
16	Voucher
19	Debit Card
23	Food voucher
27	PIX
28	Cashback
1041	Virtual gift card
4011	Debit Card / Eletronic transfer

Código	Descrição
1	Diners
2	MasterCard
3	Visa
4	Outros
5	American Express
6	HiperCard
7	Aura
10	Cartão Elo
50	LeaderCard
100	Fortbrasil
101	Sorocred
102	A Vista
103	Cartão Mais
105	Cartão C&A

ID	Description
1	Diners
2	MasterCard
3	Visa
4	Other
5	American Express
6	HiperCard
7	Aura
10	Elo Card
50	LeaderCard
100	Fortbrasil
101	Sorocred
102	Debit Card
103	Mais Card
105	C&A Card

Lista de Status (de retorno)

Status	Descrição
APA	(Aprovação Automática) – Pedido foi aprovado automaticamente segundo parâmetros definidos na regra de aprovação automática
APM	(Aprovação Manual) – Pedido aprovado manualmente por tomada de decisão de um analista
RPM	(Reprovado Sem Suspeita) – Pedido Reprovado sem Suspeita por falta de contato com o cliente dentro do período acordado e/ou políticas restritivas de CPF (Irregular, SUS ou Cancelados)
AMA	(Análise manual) – Pedido está em fila para análise
NVO	(Novo) – Pedido importado e não classificado Score pela analisadora (processo que roda o Score de cada pedido)
SUS	(Suspensão Manual) – Pedido Suspenso por suspeita de fraude baseado no contato com o “cliente” ou ainda na base ClearSale
CAN	(Cancelado pelo Cliente) – Cancelado por solicitação do cliente ou duplicidade do pedido
FRD	(Fraude Confirmada) – Pedido imputado como Fraude Confirmada por contato com a administradora de cartão e/ou contato com titular do cartão ou CPF do cadastro que desconhecem a compra
RPA	(Reprovação Automática) – Pedido Reprovado Automaticamente por algum tipo de Regra de Negócio que necessite aplicá-la
RPP	(Reprovação Por Política) – Pedido reprovado automaticamente por política estabelecida pelo cliente ou Clearsale
APP	(Aprovação Por Política) – Pedido aprovado automaticamente por política estabelecida pelo cliente ou Clearsale

ID	Description
APA	Automatic Approval - Order automatically approved based on predefined rule
APM	Manual Approval - Order manually approved by an analyst’s decision-making
RPM	Denied Without Suspicion - Order denied for lack of successful contact or restrictive policies
AMA	Manual Analysis - Order waiting for manual analysis
NVO	New - Order successfully received, but not classified yet
SUS	Manual Suspension - Order suspended manually for fraud suspicion
CAN	Cancelled by Customer - Cancelled by customer solicitation
FRD	Confirmed Fraud - Order analyzed and based on the contact, the credit card company stated the fraud or the actual owner of the card is not aware of the purchase
RPA	Denied Automatically - Order automatically denied based on predefined rule (Not recommended)
RPP	Denied by Policies – Order denied due to policies defined by ClearSale or customer
APP	Approved by Policies – Order approved due to policies defined by ClearSale or customer

Código	Descrição
0	Novo (será analisado pelo ClearSale)
9	Aprovado (irá ao ClearSale já aprovado e não será analisado)
41	Cancelado pelo cliente (irá ao ClearSale já cancelado e não será analisado)
45	Reprovado (irá ao ClearSale já reprovado e não será analisado)

ID	Description
0	New
9	Approved - This order will not be analyzed by Clearsale
41	Cancelled by the customer - This order will not be analyzed by Clearsale
45	Denied - The order will not be analyzed by Clearsale

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

ID	Description
PGA	Payment Approved
PGR	Payment Denied

Código	Descrição
0	Outros
1	Normal
2	Garantida
3	ExpressaBR
4	ExpressaSP
5	Alta
6	Econômica
7	Agendada
8	Extra Rápida
9	Impresso
10	Aplicativo
11	Correio
12	Motoboy
13	Retirada Bilheteria
14	Retirada Loja Parceira
15	Cartão de Crédito Ingresso
16	Retirada Loja
17	Retirada via Lockers (Parceiros)
18	Retirada em Agencia dos Correios
19	Entrega Garantida no mesmo dia da compra
20	Entrega Garantida no dia seguinte da compra
21	Retirada em loja - Expresso

ID	Description
0	Others
1	Normal
2	Guaranteed
3	Express Brazil
4	Express São Paulo
5	High
6	Economic
7	Schedueld
8	Extra Fast
9	Via Print
10	Via App
11	Mail
12	Motocycle Courier
13	Withdrawl at Ticket box
14	Withdrawal at Partner Store
15	Ticket Credit Card
16	Withdrawl at Store
17	Withdrawl via Lockers (Partners)
18	Withdrawl at Mail Agency
19	Guaranteed delivery on the same day of purchase
20	Guaranteed delivery the day after the purchase
21	Withdrawl at Store - Express

ID	Descrição
1	Festas
2	Shows
3	Evento universitário
4	Festivais
5	Exposições
6	Rodeio
7	Circense
8	Esportivo
9	Cinema
10	Teatro
11	Reveillon
12	Carnaval
13	Outro

ID	Description
1	Parties
2	Shows
3	University Event
4	Festivals
5	Exhibition
6	Rodeo
7	Circus
8	Sporty
9	Movie theater
10	Theater
11	New Year's Eve
12	Carnival
13	Others

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
itemValue	Valor Total dos Itens	Decimal	20,4	N
totalValue	Valor Total do Pedido	Decimal	20,4	S
ip	IP do Pedido	String	50	S
giftMessage	Mensagem de Presente	String	8000	N
observation	Observação do Pedido	String	8000	N
status	Status do Pedido	Integer		N
origin	Origem do Pedido	String	150	S
country	Nome do País	String	50	N
sla	Valor em Minutos de SLA máximo de Análise do Pedido, se houver	Integer		S
purchaseInformation	Dados de Cadastro	purchaseInformation		N
billing	Dados de cobrança	billing		S
shipping	Dados de entrega	shipping		S
payments	Dados de pagamento	Array<payment>		S
tickets	tickets	Array<ticket>		S

Object order

Property	Description	Typo	Size	Mandatory
code	Order identification	String	50	Y
sessionID	The user session id of the website	String	128	Y
date	Order date	Datetime		Y
email	Order email	String	150	Y
itemValue	Total value of the order	Decimal	20,4	N
totalValue	Total value of the order	Decimal	20,4	Y
ip	IP of the user who did the order	String	50	Y
giftMessage	Message of the gift	String	8000	N
observation	Order note	String	8000	N
status	Initial order status See the list at Initial Status List	Integer		N
origin	Order origin	String	150	Y
country	Country	String	50	N
sla	Deadline for customized analysis	Integer		Y (If applicable)
purchaseInformation	Object purchaseInformation	Object purchaseInformation		N
billing	Object billing	billing		Y
shipping	Object shipping	shipping		Y
payments	Object payments	Array<payment>		Y
tickets	tickets	Array<ticket>		Y

HttpCode:	400 (Bad Request)
Body:	{ "Message": "The request is invalid.", "ModelState": { "< JPath_da_Propriedade >": [ "< Mensagem_Nome_Propriedade_descricao_erro > ] } }

HttpCode:	400 (Bad Request)
Body:	{ "Message": "The request is invalid.", "ModelState": { "< JPath_da_Propriedade >": [ < Mensagem_Nome_Propriedade_descricao_erro> ] } }

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
lastDateInsertedMail	Data da última alteração do e-mail	Datetime		N
lastDateChangePassword	Data da última alteração da senha	Datetime		N
lastDateChangePhone	Data da última alteração do telefone	Datetime		N
lastDateChangeMobilePhone	Data da última alteração do telefone móvel	Datetime		N
lastDateInsertedAddress	Data da última alteração do endereço	Datetime		N
purchaseLogged	Compra logado	boolean		N
email	E-mail de Cadastro	String	200	N
login	Login de Acesso	String	200	N

Property	Description	Type	Size	Mandatory
lastDateInsertedMail	Last email change date	Datetime		N
lastDateChangePassword	Last password change date	Datetime		N
lastDateChangePhone	Last phone change date	Datetime		N
lastDateChangeMobilePhone	Last mobile phone change date	Datetime		N
lastDateInsertedAddress	Last address change date	Datetime		N
purchaseLogged	Logged purchase (true or false)	boolean		N
email	Social network email	String	200	N
login	Social network login	String	200	N

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
email	Email	String	150	N
gender	Sexo	String	1	N
motherName	Nome da mãe do cliente	String	500	N
address	Endereço	address		S
phones	Telefones	Array<phone>		S

Property	Description	Type	Size	Mandatory
clientID	Customer ID	String	50	N
type	Natual or Legal Person See the list at Person Type List	Integer		Y
primaryDocument	CPF or CNPJ	String	100	Y
secondaryDocument	RG or state registration	String	100	N
name	Customer name	String	500	Y
birthDate	Customer birth date	Datetime		N
email	Email	String	150	N
gender	Gender See the list at Gender List	String	1	N
motherName	Customer mother's name	String	500	N
address	Object address	address		Y
phones	Object Phones	Array<phone>		Y

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
card	cartão	card		S

Property	Description	Type	Size	Mandatory
sequential	Number indicating the payment sequence	Integer		N
date	Payment date	Datetime		N
value	Payment value	Decimal	20,4	N
type	Payment type See the list at Payment Type List	Integer		Y
installments	Amount of installments	Integer		N
interestRate	Interest rate	Decimal	4,2	N
interestValue	Interest value	Decimal	20,4	N
card	Object card	Object card		Y

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	S
zipcode	CEP do Endereço	String	10	S
reference	Referência do Endereço	String	250	N

Property	Description	Type	Size	Mandatory
street	Street name	String	200	Y
number	Address number	String	15	Y
additionalInformation	Address Complement	String	250	N
county	Address district	String	150	Y
city	Address city	String	150	Y
state	Address state initials	String	2	Y
country	Address country	String	150	Y
zipcode	Address zip code	String	10	Y
reference	Address reference	String	250	N

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

Property	Description	Type	Size	Mandatory
type	Phone type See the list at Phone Type List	Integer		Y
ddi	Country code	Integer	3	N
ddd	Area code	Integer	2	Y
number	Phone number	Integer	9	Y
extension	Phone extension	String	10	N

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
convenienceFeeValue	Taxa de Conveniência	Decimal	10,4	N
quantityFull	Quantidade de ingressos com valor integral	Integer		N
quantityHalf	Quantidade de ingresso com desconto (meia entrada)	Integer		N
batch	Lote do Ingresso	Integer		N
virtual	Ingresso Virtual (informar "true" ou "false")	Boolean		N
event	Evento	event		S
peoples	Pessoas	Array<people>		N
categories	Categorias	Array<category>		N
additionalInformations	Informações adicionais	Array<additionalInformation>		N

Property	Description	Type	Size	Mandatory
convenienceFeeValue	Rate of Convenience Fee Value	Decimal	10,4	N
quantityFull	Ticket's full price quantity	Integer		N
quantityHalf	Ticket's half price quantity	Integer		N
batch	Ticket's batch	Integer		N
virtual	Virtual Ticket (inform "true" or "false")	Boolean		N
event	Event	event		Y
peoples	People	Array<people>		N
categories	Categories	Array<category>		N
additionalInformations	Additional Informations	Array<additionalInformation>		N

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
number	Número do Cartão com Máscara	String	200	N
hash	Hash do número do cartão	String	128	N
bin	6 Primeiros Números do Cartão de Crédito	String	6	S
end	4 últimos digitos do número de cartão	String	4	S
type	Bandeira do Cartão	Integer		S
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	S
nsu	Número identificador único de uma transação de cartão	String	50	N

Property	Description	Type	Size	Mandatory
number	Bank card number	String	200	N
hash	Card number hash	String	128	N
bin	Bank card bin	String	6	Y
end	Last 4 digits of the bank card	String	4	Y
type	Flag type of the bank card See the list at BankCard Flag List	Integer		Y
validityDate	Expiration date	String	50	N
ownerName	Card holder	String	150	Y
document	Legal document of the card holder	String	100	Y
nsu	Transaction identification number of the bank card	String	50	N

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
id	Código do evento	String	50	N
name	Nome do Evento	String	200	S
local	Local do Evento	String	200	S
date	Data do Evento	Datetime		S
type	Lista de Evento	Integer		S
genre	Genero do tipo de evento	String	200	N
quantityTicketSale	Quantidade de Ingresso à venda	Integer		N
quantityEventHouse	Quantidade de vezes que o evento será realizado na casa	Integer		N
address	Endereço do evento	eventAddress		S

Property	Description	Type	Size	Mandatory
id	Event code	String	50	N
name	Event name	String	200	Y
local	Event local	String	200	Y
date	Event date	Datetime		Y
type	Event list	Integer		Y
genre	Event type gender	String	200	N
quantityTicketSale	Number of tickets on sale	Integer		N
quantityEventHouse	Number of times the event will be held at the house	Integer		N
address	Event adress	eventAddress		Y

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
name	Nome da Pessoa que comparecerá ao evento.	String	200	S
legalDocument	Documento de identificação da pessoa que comparecerá ao evento	String	50	S

Property	Description	Type	Size	Mandatory
name	Name of Person who will be at the event	String	200	Y
legalDocument	Identification document of the person who will be at the event	String	50	Y

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
name	Descrição da categoria do Ingresso comprado	String	200	S
quantity	Quantidade de ingressos comprado na categoria	Integer		S
value	Valor unitário do ingresso na categoria	Decimal	10,4	S

Property	Description	Type	Size	Mandatory
name	Ticket category description	String	200	Y
quantity	Ticket category quantity	Integer		Y
value	Ticket category value	Decimal	10,4	Y

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
name	Nome do produto adicional adquirido	String	200	S
quantity	Quantidade do produto adicional adquirido	Integer		S
value	Valor do produto adicional adquirido	Decimal	10,4	S

Property	Description	Type	Size	Mandatory
name	Additional product name purchased	String	200	Y
quantity	Quantity of additional product purchased	Integer		Y
value	Value of additional product purchased	Decimal	10,4	Y

Tickets - Tickets Garantido (Nova regras para ofertas garantidas)

Tickets - Tickets Guaranteed (New rules for guaranteed offers)

Introdução +

Introduction +

Etapas da Homologação +

Sandbox Steps +

Operações API +

API operations +

Autenticação do Token

Requisição

Resposta

Inclusão de Pedidos

Requisição

Resposta

Token Authentication

Request

Response

Send orders

Request

Response

Notificação de alteração de status (Webhook)

Requisição

Update Status Notification

Request

Consulta de Status

Requisição

Resposta

Status Check

Request

Response

Atualização de Status

Requisição

Resposta

Status Update

Request

Response

Marcação de Chargeback

Requisição

Resposta

Chargeback Authentication

Request

Response

Tabelas código e descrição +

Appendix +

Tipo de telefone (billing/shipping.phone.type)

Phone Type List (billing/shipping.phone.type)

Tipo pessoa (billing/shipping.type)

Person Type (billing/shipping.type)

Tipo de sexo (billing/shipping.gender)

Gender Type (billing/shipping.gender)

Tipo de pagamento (payment.type)

Payment Type (payment.type)

Bandeira Cartão de Crédito (card.type)

Bank Card Flag List (card.type)

Lista de Status (de retorno)

Analysis Status List

Lista de Status (de entrada)

Initial Status List * (orders.status)

Status de pagamento

Statuses of Payments

Tipo de Entrega (shipping.deliveryType)

Delivery Types (shipping.deliveryType)

Lista de Eventos (ticket.event.type)

Lists of Events(ticket.event.type)

Descrição de campos +

Fields Description +

Objeto order

Object order

Objeto purchaseInformation

Object purchaseInformation

Objeto billing

Object billing

Objeto shipping

Object shipping

Objeto payments

Object payments

Objeto address

Object address

Objeto phones

Object phones

Introdução

Introduction

Etapas da Homologação

Sandbox Steps

Operações API

API operations

Tabelas código e descrição

Appendix

Descrição de campos

Fields Description

Resolução de problemas

Troubleshooting