Home

Descripción general

ClearSale

Credenciales necesarias#

Como se menciona en el capítulo de "Descripción general - Credenciales requeridas", cada institución tiene un conjunto de credenciales que deben obtenerse para la integración. Los servicios de ClearSale requieren las siguientes credenciales:

  • Acceso (Identificación de la tienda) - Acceso del registro de la tienda en la ClearSale.
  • Contraseña (Merchant Code) - Contraseña del registro de la tienda en la ClearSale.

IMPORTANTE: Las credenciales anteriores deben obtenerse de ClearSale. El comerciante debe comunicarse con ClearSale y recibir la orientación adecuada sobre cómo obtener cada una de estas credenciales. Después de obtener las credenciales, el comerciante debe comunicarse con el soporte de Portal Carat y pasar las credenciales para registrarse en Portal Carat.

Configuración de URL de webhook#

Para que sea posible recibir las actualizaciones de estado de las transacciones de análisis de riesgo, es necesario realizar la configuracion de la URL de webhook en el ambiente de configuración de ClearSale.

URL de producción:

https://esitef-ec.softwareexpress.com.br/e-sitef/processarPost.se?src=clearsale_rest

URL de aprobación:

https://esitef-homologacao.softwareexpress.com.br/e-sitef/processarPost.se?src=clearsale_rest

Esta URL debe configurarse para cualquier cambio de estado. Para realizar esta configuración, comuníquese con el Soporte de ClearSale.

Iniciar una transacción con AntiFraude#

Después de realizar la alineación del registro con el soporte en línea de Portal Carat para habilitar la integración con el servicio antifraude, en la inicialización de un Pago REST (más información) o una transacción de Autorización previa REST (más información), el comerciante debe enviar la propiedad anti_fraud y enviar los parámetros antifraude apropiados (depende de la institución para la que se haya configurado su tienda), y ambas propiedades deben estar en el alcance del objeto additional_data.

El campo anti_fraud determina el modo de aplicación antifraude y puede contener los siguientes valores:

  • enabled_before_auth: el análisis antifraude se realizará ANTES de la autorización del pago. Si se rechaza el análisis, no se iniciará el pago. En el caso de preautorización con rutas no SiTef, si el análisis de riesgo queda como análisis manual, el Portal Carat deja la transacción en estado PPC (Pago Pendiente de Confirmación) y espera la finalización del análisis manual.
  • enabled_after_auth: el análisis antifraude se realizará DESPUÉS de la autorización del pago. Si se rechaza el análisis, se cancelará el pago que ya ha sido autorizado. En el caso de preautorización con rutas que no son SiTef, el Portal Carat deja la transacción en estado PPC (Pago Pendiente de Confirmación) y espera la finalización del análisis manual.

NOTA: Las transacciones que están pendientes de pago pueden ser confirmadas o deshechas por límite de tiempo. Más información

Configuración ClearSale Realtime#

Después de realizar el ajuste de registro con el equipo de soporte de carat para habilitar la integración con el servicio ClearSale, la tienda debe iniciar una transacción de pago REST o HTML enviando la propiedad "anti_fraud" y enviando los parámetros datos adicionales recolectados para el análisis de riesgo de la transacción que se envía en el objeto additional_data.

Versiones del servicio ClearSale compatibles con la interfaz de pago:#

ClearSale - Total

ClearSale - RealTime

Parámetros antifraude de ClearSale#

A continuación se muestra la lista de parámetros antifraude procesados por ClearSale.

NOTA: Los campos a continuación son específicos para la integración de ClearSale y sus criterios y formato obligatorios se refieren a las validaciones realizadas por la institución de análisis de fraude. Es importante que estos criterios se respeten para un análisis efectivo y preciso.

Datos adicionales de transaccion Información acerca del comprador Información acerca del navegador del comprador Información acerca de la compra Información sobre redes sociales relacionadas Información acerca de la facturación Información sobre los teléfonos de facturación (los campos marcados con SÍ solo son obligatorios si se crea el objeto phones) Información sobre los documentos de identificación para facturación Información sobre la dirección de entrega (los campos marcados con SÍ solo son obligatorios si se crea el objeto address) Información sobre los teléfonos de entrega (los campos marcados con SÍ solo son obligatorios si se crea el objeto phones) Información sobre los documentos de identificación para entrega Información sobre los artículos comprados Información sobre las direccónes del pago (los campos marcados con SÍ solo son obligatorios si se crea el objeto receiver_address) Información sobre la tarjeta del pago Información sobre ele pas Informações relativas a los pasajeros (los campos marcados con SÍ solo son obligatorios si se crea el objeto passenger_data) Información sobre las coneccíones de aire (los campos marcados con SÍ solo son obligatorios si se crea el objeto flight_connection) Información sobre reservaciónes de hotel
ParámetroDescripciónRequeridoFormato
additional_data
b2b_b2cTipo de comercio electrónico.NO3 A
item_amountValor total de los artículos en centavosSÍ<1024 N
total_order_amountValor total del pedido en centavos. Compuesto por el Valor Total de los Artículos + Valor de Envío + Posible Valor de Interés de la CompraSÍ<1024 N
giftIndica si el pedido es un regalo:
1 - es un regalo
0 - no es un regalo.
Si está ausente, se asume el valor 0.		NO1 N
gift_messageMensaje de regaloNO<1024 AN
obsObservación del pedidoNO<1024 AN
sla_customValor en minutos del máximo SLA, si lo hayNO4 N
originCanal de Origen del Pedido (ej: TELE VENTAS, SITIO WEB, APP, etc.)SÍ<150 A
channel_idCanal de Origen complementario, si lo hay. (ej: ANDROID, IOS, etc.)NO<1024 AN
reservation_dateFecha del Primer Vuelo del Pedido (en caso de boleto aéreos).NOyyyy-mm-ddThh:mm:ss
nationalityNacionalidadNO<50 AN
productIdentificación del producto ClearSale:
-1 (Otros),
1 (Application),
3 (Total),
4 (Total Garantido),
9 (Score),
10 (Realtime Decision),
11 (Tickets)		NO2N
bank_authenticationTipo de autenticación del bancoNO<1024 AN
sub_acquirerNombre del subadquirenteNO<1024 AN
list_type_idTipo de Lista:
1 - Lista no Cadastrada,
2 - Lista de Baby Shower,
3 - Lista de Bodas,
4 - Lista de Deseos,
5 - Lista de Cumpleaños,
6 - Lista de Despedida de Soltero		NO1N
list_idID de la lista en la TiendaNO<1024 AN
additional_data
.payer
emailCorreo electrónico del compradorSÍ<1024 AN
nameNombre del compradorSÍ<150 A
legal_documentNúmero del documento del compradorSÍ<100 A
additional_data
.browser
ip_addressIP del PedidoNO<1024 AN
additional_data
.purchase_information_data
last_date_change_inserted_mailFecha del último cambio de correo electrónicoNOyyyy-mm-ddThh:mm:ss
last_date_change_passwordFecha del último cambio de contraseñaNOyyyy-mm-ddThh:mm:ss
last_date_change_phoneFecha del último cambio de teléfonoNOyyyy-mm-ddThh:mm:ss
last_date_change_mobile_phoneFecha del último cambio de teléfono móvilNOyyyy-mm-ddThh:mm:ss
last_date_inserted_addressFecha del último cambio de direcciónNOyyyy-mm-ddThh:mm:ss
purchase_loggedIndica compra con usuario registrado:
1 para SÍ,
0 para NO;
si está ausente o no es válido, se asume el valor 0		NO1N
emailCorreo electrónico de registroNO<1024 AN
loginNombre de usuário de sesiónNO<1024 AN
additional_data
.social_network
social_network.opt_in_buy_and_trustIndica si el cliente acepta sumarse al movimiento Compre e Confie:
1 para SÍ,
0 para NO;
si está ausente o no es válido, se asume el valor 0		NO1N
social_network.type_social_networkIdentificación de la red social relacionada:
1 - Facebook,
2 - Twitter,
3 - Linkedin,
4 - Google,
5 - Otros		NO1N
social_network.authentication_tokenToken retornado por la red socialNO<1024 AN
additional_data
.billing_data
client_idCódigo de clienteNO<1024 AN
personTipo de la Persona:
1 - Persona Física ou
2 - Persona Jurídica		SÍ1N
cnpj_cpfCPF o CNPJ. Si está ausente, ClearSale utiliza el valor informado en la lista additional_data.billing_data.documents[] utilizando las claves CPF o CNPJ, lo que se encuentre primero.COND<1024 AN
identification_numberDocumento Nacional de Identidad o Inscripción Provicincial. Si está ausente, ClearSale utiliza el primeiro valor informado en la lista additional_data.billing_data.documents[] utilizando la clave RG.COND<1024 AN
nameNombre del clienteSÍ<1024 A
birth_dateFecha de nacimientoNOyyyy-mm-ddThh:mm:ss
emailCorreo electrónicoNO<1024 AN
genderSexo del comprador:
M - Masculino o
F - Feminino		NO1A
billing_data
.address
street_nameNombre de la calleSÍ<1024 AN
street_numberNúmero de direcciónSÍ<1024 AN
complementComplemento de direcciónNO<1024 AN
countyDistritoSÍ<1024 AN
cityCiudadSÍ<1024 AN
stateAbreviatura de estadoSÍ2 A
countryPaísNO<1024 AN
zip_codeCódigo postalSÍ<1024 AN
referenceReferencia de la direcciónNO<1024 AN
billing_data
.phones[]
typeTipo de teléfono:
0 - No definido,
1 - Residencial,
2 - Comercial,
3 - Mensajes,
4 - Facturación,
5 - Temporal,
6 - Celular		SÍ1N
ddiDDI del teléfonoNO3 N
dddDDD del teléfonoSÍ2 N
numberNúmero del teléfonoSÍ9 N
extensionExtensión del teléfonoNO10 N
billing_data
.documents[]
typeTipo de DocumentoNO<1024 AN
numberNúmero de DocumentoNO<1024 AN
additional_data
.shipment
client_idCódigo de clienteNO<1024 AN
personTipo de persona:
1 - Persona Física ou
2 - Persona Jurídica		SÍ1N
cnpj_cpfCPF o CNPJ. Si está ausente, ClearSale utiliza el valor informado en la lista additional_data.shipment.documents[] utilizando las claves CPF ou CNPJ, lo que se encuentre primero.COND<1024 AN
identification_numberDocumento Nacional de Identidad o Inscripción Provicincial. Si está ausente, ClearSale utiliza el primeiro valor informado en la lista additional_data.shipment.documents[] utilizando la clave RG.COND<1024 AN
nameNombre del recipienteSÍ<1024 AN
birth_dateFecha de nacimiento del destinatárioNOyyyy-mm-ddThh:mm:ss
emailCorreo electrónico del destinatárioNO<1024 AN
genderSexo del destinatário:
M - Masculino ou
F - Feminino		NO1A
delivery_typeTipo de entrega:
0 - Otros,
1 - Normal,
2 - Garantizada,
3 - ExpressaBR,
4 - ExpressaSP,
5 - Alta,
6 - Económica,
7 - Programada,
8 - Extra Rápida,
9 - Impreso,
10 - Aplicación,
11 - Correo,
12 - Mensajero de moto,
13 - Recoger en taquilla,
14 - Recoger en Tienda Asociada,
15 - Tarjeta de crédito de entrada,
16 - Recoger en Tienda,
17 - Recoger via Lockers (Asociados),
18 - Recoger en Oficina de Correos,
19 - Entrega Garantizada en el mismo día,
20 - Entrega Garantizada al día siguiente ,
21 - Recoger en la tienda - Expresso		SÍ<2 N
delivery_timePlazo de EntregaNO<1024 AN
costCosto de envío en centavosNO<1024 N
pickup_store_documentCPF para recoger en tienda (si el pedido es para algún tipo de entrega recoger)NO<1024 N
shipment
.address
street_nameNombre de la calleSÍ<1024 AN
street_numberNúmero de direcciónSÍ<1024 AN
complementComplemento de direcciónNO<1024 AN
countyDistritoSÍ<1024 AN
cityCiudadSÍ<1024 AN
stateAbreviatura de estadoSÍ2 A
countryPaísNO<1024 AN
zip_codeCódigo postalSÍ<1024 AN
referenceReferencia de la direcciónNO<1024 AN
shipment
.phones[]
typeTipo de teléfono:
0 - No definido,
1 - Residencial
2 - Comercial
3 - Mensajes
4 - Facturación
5 - Temporal
6 - Celular		SÍ1N
ddiDDI del teléfonoNO3 N
dddDDD del teléfonoSÍ2 N
numberNúmero del teléfonoSÍ9 N
extensionExtensión del teléfonoNO10 N
billing_data
.documents[]
typeTipo de Documento:
CPF
CNPJ		NO<1024 AN
numberNúmero de DocumentoNO<1024 AN
additional_data
.items[]
idCódigo de ProductoNO<1024 AN
titleNombre de ProdutoSÍ<1024 AN
eanEAN (Código de barras) de produtoNO<1024 AN
unit_priceValor unitario en centavosNO<1024 N
quantityCantidadNO<1024 N
category_idCódigo de categoría de productoNO<1024 N
category_nameNombre de categoría de produtoNO<1024 AN
giftIndica si el artículo es un regalo.
1 - és un regalo
0 - no és un regalo
Si no está presente, se asume 0		NO1N
sellerNameNombre comercial del asociadoNO<1024 AN
sellerDocumentCNPJ del asociadoNO<1024 AN
marketPlaceIndica sí el establecimiento es un market place: true o falseNO<A
sellerSegmentSegmento del asociado.NO<1024 AN
shippingCompanyNombre de la compañía de enviosNO<1024 AN
sequentialSecuencia de efectuación del pagoNO<1024 N
voucher_order_originID del pedido que generó un Token de cambio (sí el método de pago fue Voucher)NO<1024 AN
payer
.receiver_address
street_nameNombre de la calleSÍ<1024 AN
street_numberNúmero de direcciónSÍ<1024 AN
complementComplemento de direcciónNO<1024 AN
countyDistritoSÍ<1024 AN
cityCiudadSÍ<1024 AN
stateAbreviatura de estadoSÍ2 A
countryPaísNO<1024 AN
zip_codeCódigo postalSÍ<1024 AN
referenceReferencia de la direcciónNO<1024 AN
payer
.card
nameNombre de facturaciónSÍ<1024 A
legal_documentDocumento de la persona de facturaciónNO<1024 AN
additional_data
.passenger_data[]
nameNombre del pasajeroSÍ<1024 AN
company_mileEmpresa del Programa de Viajero FrecuenteNO<1024 AN
frequente_flyer_cardTarjeta del Programa de Viajero FrecuenteNO<1024 AN
legal_document_typeTipo de documento de identificación:
1 - CPF
2 - CNPJ
3 - RG
4 - IE
5 - Pasaporte
6 - CTPS
7 - Título Eleitor		NO1N
legal_documentNúmero de DocumentoNO<1024 N
birth_dateFecha de nacimientoNOyyyy-mm-ddThh:mm:ss
genderSexo del pasajero:
M - Masculino
F - Femenino		NO1A
additional_data
.flight_connection[]
companyNombre de la aerolíneaNO<1024 AN
flight_numberNúmero del vueloNO<1024 AN
flight_dateFecha del vueloNOyyyy-mm-ddThh:mm:ss
classClase de asientoNO<1024 AN
fromOrigenNO<1024 AN
toDestinoNO<1024 AN
departure_dateFecha de salidaSÍyyyy-mm-ddThh:mm:ss
arrival_datefecha de llegadaSÍyyyy-mm-ddThh:mm:ss
class_codeClase de tarifaNO<1024 AN
additional_data
.reservation_hotel[]
hotelNombre del hotelNO<1024 AN
cityCiudadNO<1024 AN
stateEstadoNO<1024 AN
countryPaísNO<1024 AN
reservation_dateFecha de la reservaNOyyyy-mm-ddThh:mm:ss
reservation_expiration_dateFecha de vencimiento de la reservaNOyyyy-mm-ddThh:mm:ss
checkin_dateFecha de llegadaNOyyyy-mm-ddThh:mm:ss
checkout_dateFecha de salidaNOyyyy-mm-ddThh:mm:ss

Ejemplo#

Ejemplo de solicitud de creación con los parámetros mínimos de pago REST con análisis de riesgo en ClearSale: Más información sobre los parámetros de pago.

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"merchant_usn":"27112936137",
"order_id":"27112936137",
"installments":"1",
"installment_type":"4",
"authorizer_id":"2",
"amount":"1000",
"additional_data":{
"payer":{
"email":"payer@email.com",
"name" : "Payer Name",
"legal_document" : "7777777777"
},
"shipment":{
"type":"1",
"name":"ShipmentName",
"person":"1",
"address":{
"zip_code":"1111111",
"street_number":"111",
"street_name":"Billing StreetName",
"city":"Billing City",
"state":"Billing State",
"county":"Billing County"
}
},
"anti_fraud":"enabled_before_auth",
"billing_data":{
"person":"1",
"name":"BillingName",
"address":{
"zip_code":"1111111",
"street_number":"111",
"street_name":"Billing StreetName",
"city":"Billing City",
"state":"Billing State",
"county":"Billing County"
}
},
"item_amount":"10",
"origin":"origin",
"total_order_amount":"10"
}
}
--verbose

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"payment": {
"status": "NOV",
"nit": "50f36d5b28510b0fb2b83951b533c5a9f9306b9ef54fc0a9220a5ce3c7845d17",
"order_id": "27112936137",
"merchant_usn": "27112936137",
"amount": "1000"
}
}

Ejemplo de solicitud de creación con los demás parámetros de pago REST con análisis de riesgo en ClearSale:#

Solicitud:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"merchant_usn":"8032934075",
"order_id":"08032934333",
"installments":"1",
"installment_type":"4",
"authorizer_id":"2",
"amount":"1000",
"additional_data":{
"items":[
{
"title":"title1",
"quantity":"1",
"unit_price":"1",
"category_id":"categoryId1",
"id":"id1",
"gift":"true",
"category_name":"categoryName1",
"ean":"ean1",
"seller_name":"sellerName1",
"seller_document":"sellerDocument1",
"market_place":"true",
"seller_segment":"sellerSegment1",
"shipping_company":"shippingCompany1"
},
{
"title":"title2",
"quantity":"2",
"unit_price":"2",
"category_id":"categoryId2",
"id":"id2",
"gift":"false",
"category_name":"categoryName2",
"ean":"ean2",
"seller_name":"sellerName2",
"seller_document":"sellerDocument2",
"market_place":"false",
"seller_segment":"sellerSegment2",
"shipping_company":"shippingCompany2"
}
],
"payer":{
"name":"Payer Name",
"email":"payer@email.com",
"city":"Payer City",
"state":"SP",
"legal_document":"7777777777",
"address_street_name":"Payer Street",
"address_street_number":"444",
"address_zip_code":"6666666",
"address_street_complement":"Payer Complement",
"address_country":"Payer Country",
"address_reference":"Payer Reference",
"address_county":"Payer County",
"neighborhood":"Payer County"
},
"shipment":{
"type":"1",
"cost":"5",
"id":"ShipmentClientId",
"name":"ShipmentName",
"person":"1",
"birth_date":"1990-01-10T00:00:00.000",
"email":"Shipment@Email",
"gender":"M",
"address":{
"zip_code":"2222222",
"street_number":"111",
"street_name":"Shipping StreetName",
"complement":"Shipping Complement",
"city":"Shipping City",
"state":"Shipping State",
"country":"Brasil",
"county":"Shipping County",
"reference":"Shipping Reference"
},
"legal_document1":"0987654321",
"legal_document2":"87654321",
"delivery_type":"1",
"delivery_deadline":"2 dias uteis",
"pickup_store_document":"12345678910"
},
"item_amount":"10",
"anti_fraud":"enabled_before_auth",
"passengers":[
{
"name":"Name1",
"frequent_flyer_card":"frequentFlyerCard1",
"legal_document_type":"1",
"legal_document":"111111111",
"birth_date":"2000-01-01T00:00:00",
"company_mile":"companyMile1",
"gender":"M"
},
{
"name":"Name2",
"frequent_flyer_card":"frequentFlyerCard2",
"legal_document_type":"0",
"legal_document":"22222222",
"birth_date":"2000-01-02T00:00:00",
"company_mile":"companyMile2",
"gender":"M"
}
],
"connections":[
{
"company":"company1",
"flight_number":"666",
"flight_date":"2000-01-03T00:00:00",
"class":"ECONOMY",
"from":"BRA",
"to":"ARG",
"departure_date":"2000-01-04T00:00:00",
"arrival_date":"2000-01-05T00:00:00",
"class_code":"classCode1"
},
{
"company":"company2",
"flight_number":"333",
"flight_date":"2000-01-06T00:00:00",
"class":"ECONOMY",
"from":"BRA",
"to":"ENG",
"departure_date":"2000-01-07T00:00:00",
"arrival_date":"2000-01-08T00:00:00",
"class_code":"classCode2"
}
],
"hotel_reservations":[
{
"hotel":"hotel1",
"city":"city1",
"state":"state1",
"country":"country1",
"reservation_date":"2000-01-09T00:00:00.000",
"reservation_expiration_date":"2000-01-10T00:00:00.000",
"checkin_date":"2000-01-11T00:00:00.000",
"checkout_date":"2000-01-12T00:00:00.000"
}
],
"purchase_information_data":{
"last_date_inserted_mail":"2020-01-01T01:01:01",
"last_date_change_password":"2020-01-02T02:02:02",
"last_date_change_phone":"2020-01-03T03:03:03",
"last_date_change_mobile_phone":"2020-01-04T04:04:04",
"last_date_inserted_address":"2020-01-05T05:05:05",
"purchase_logged":"false",
"email":"purchaseInformation@email",
"login":"purchaseInformationLogin"
},
"billing_data":{
"client_id":"BillingClientId",
"person":"1",
"gender":"M",
"name":"BillingName",
"birth_date":"1990-01-10T00:00:00.000",
"email":"Billing@Email",
"address":{
"zip_code":"1111111",
"street_number":"111",
"street_name":"Billing StreetName",
"complement":"Billing Complement",
"city":"Billing City",
"state":"Billing State",
"country":"Brasil",
"county":"Billing County",
"reference":"Billing Reference"
},
"phones":[
{
"number":"199999999",
"ddd":"11",
"ddi":"55",
"extension":"1888",
"type":"1"
},
{
"number":"299999999",
"ddd":"11",
"ddi":"55",
"extension":"2888",
"type":"2"
}
],
"cnpj_cpf":"12345678911",
"identification_number":"12345678"
},
"b2b_b2c":"b2b",
"sla_custom":"1",
"gift":"true",
"gift_message":"giftMessage",
"obs":"obs",
"origin":"origin",
"nationality":"nationality",
"product":"4",
"list_type_id":"1",
"list_id":"listId",
"sequential":"33",
"interest_value":"2",
"interest":"10",
"total_order_amount":"10",
"browser":{
"ip_address":"1111.222.333.444"
},
"bank_authentication":"bankAuthentication",
"sub_acquirer":"subAcquirer",
"social_network":{
"opt_in_buy_and_trust":"1",
"type_social_network":"1",
"authentication_token":"authenticationToken"
},
"voucher_order_origin":"voucherOrderOrigin",
"channel_id":"channelId"
}
}
--verbose

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"payment": {
"status": "NOV",
"nit": "0cbaaa37480ebb0f6480a944f99af1b4976a3a91db270f2dd20c15ac01dbaea4",
"order_id": "08032934333",
"merchant_usn": "8032934075",
"amount": "1000"
}
}

Ejemplo de solicitud de creación con los parámetros mínimos de Autorización previa con análisis de riesgo en ClearSale:#

Solicitud:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"merchant_usn":"27112936137",
"order_id":"27112936137",
"installments":"1",
"transaction_type":"preauthorization",
"installment_type":"4",
"authorizer_id":"2",
"amount":"1000",
"additional_data":{
"payer":{
"email":"payer@email.com",
"name" : "Payer Name",
"legal_document" : "7777777777"
},
"shipment":{
"type":"1",
"name":"ShipmentName",
"person":"1",
"address":{
"zip_code":"1111111",
"street_number":"111",
"street_name":"Billing StreetName",
"city":"Billing City",
"state":"Billing State",
"county":"Billing County"
}
},
"anti_fraud":"enabled_before_auth",
"billing_data":{
"person":"1",
"name":"BillingName",
"address":{
"zip_code":"1111111",
"street_number":"111",
"street_name":"Billing StreetName",
"city":"Billing City",
"state":"Billing State",
"county":"Billing County"
}
},
"item_amount":"10",
"origin":"origin",
"total_order_amount":"10"
}
}
--verbose

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"pre_authorization": {
"status": "NOV",
"nit": "25b0bfc9ef3d38f1ca09fbcf6d6cb6957b78a04c731da707884dbaf85185f380",
"order_id": "27112936137",
"merchant_usn": "27112936137",
"amount": "1000"
}
}

Ejemplo de solicitud de creación con los otros parámetros de Autorización previa con análisis de riesgo en ClearSale:#

Solicitud:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"merchant_usn":"8032934075",
"order_id":"08032934333",
"installments":"1",
"installment_type":"4",
"transaction_type":"preauthorization",
"authorizer_id":"2",
"amount":"1000",
"additional_data":{
"items":[
{
"title":"title1",
"quantity":"1",
"unit_price":"1",
"category_id":"categoryId1",
"id":"id1",
"gift":"true",
"category_name":"categoryName1",
"ean":"ean1",
"seller_name":"sellerName1",
"seller_document":"sellerDocument1",
"market_place":"true",
"seller_segment":"sellerSegment1",
"shipping_company":"shippingCompany1"
},
{
"title":"title2",
"quantity":"2",
"unit_price":"2",
"category_id":"categoryId2",
"id":"id2",
"gift":"false",
"category_name":"categoryName2",
"ean":"ean2",
"seller_name":"sellerName2",
"seller_document":"sellerDocument2",
"market_place":"false",
"seller_segment":"sellerSegment2",
"shipping_company":"shippingCompany2"
}
],
"payer":{
"name":"Payer Name",
"email":"payer@email.com",
"city":"Payer City",
"state":"SP",
"legal_document":"7777777777",
"address_street_name":"Payer Street",
"address_street_number":"444",
"address_zip_code":"6666666",
"address_street_complement":"Payer Complement",
"address_country":"Payer Country",
"address_reference":"Payer Reference",
"address_county":"Payer County",
"neighborhood":"Payer County"
},
"shipment":{
"type":"1",
"cost":"5",
"id":"ShipmentClientId",
"name":"ShipmentName",
"person":"1",
"birth_date":"1990-01-10T00:00:00.000",
"email":"Shipment@Email",
"gender":"M",
"address":{
"zip_code":"2222222",
"street_number":"111",
"street_name":"Shipping StreetName",
"complement":"Shipping Complement",
"city":"Shipping City",
"state":"Shipping State",
"country":"Brasil",
"county":"Shipping County",
"reference":"Shipping Reference"
},
"legal_document1":"0987654321",
"legal_document2":"87654321",
"delivery_type":"1",
"delivery_deadline":"2 dias uteis",
"pickup_store_document":"12345678910"
},
"item_amount":"10",
"anti_fraud":"enabled_before_auth",
"passengers":[
{
"name":"Name1",
"frequent_flyer_card":"frequentFlyerCard1",
"legal_document_type":"1",
"legal_document":"111111111",
"birth_date":"2000-01-01T00:00:00",
"company_mile":"companyMile1",
"gender":"M"
},
{
"name":"Name2",
"frequent_flyer_card":"frequentFlyerCard2",
"legal_document_type":"0",
"legal_document":"22222222",
"birth_date":"2000-01-02T00:00:00",
"company_mile":"companyMile2",
"gender":"M"
}
],
"connections":[
{
"company":"company1",
"flight_number":"666",
"flight_date":"2000-01-03T00:00:00",
"class":"ECONOMY",
"from":"BRA",
"to":"ARG",
"departure_date":"2000-01-04T00:00:00",
"arrival_date":"2000-01-05T00:00:00",
"class_code":"classCode1"
},
{
"company":"company2",
"flight_number":"333",
"flight_date":"2000-01-06T00:00:00",
"class":"ECONOMY",
"from":"BRA",
"to":"ENG",
"departure_date":"2000-01-07T00:00:00",
"arrival_date":"2000-01-08T00:00:00",
"class_code":"classCode2"
}
],
"hotel_reservations":[
{
"hotel":"hotel1",
"city":"city1",
"state":"state1",
"country":"country1",
"reservation_date":"2000-01-09T00:00:00.000",
"reservation_expiration_date":"2000-01-10T00:00:00.000",
"checkin_date":"2000-01-11T00:00:00.000",
"checkout_date":"2000-01-12T00:00:00.000"
}
],
"purchase_information_data":{
"last_date_inserted_mail":"2020-01-01T01:01:01",
"last_date_change_password":"2020-01-02T02:02:02",
"last_date_change_phone":"2020-01-03T03:03:03",
"last_date_change_mobile_phone":"2020-01-04T04:04:04",
"last_date_inserted_address":"2020-01-05T05:05:05",
"purchase_logged":"false",
"email":"purchaseInformation@email",
"login":"purchaseInformationLogin"
},
"billing_data":{
"client_id":"BillingClientId",
"person":"1",
"gender":"M",
"name":"BillingName",
"birth_date":"1990-01-10T00:00:00.000",
"email":"Billing@Email",
"address":{
"zip_code":"1111111",
"street_number":"111",
"street_name":"Billing StreetName",
"complement":"Billing Complement",
"city":"Billing City",
"state":"Billing State",
"country":"Brasil",
"county":"Billing County",
"reference":"Billing Reference"
},
"phones":[
{
"number":"199999999",
"ddd":"11",
"ddi":"55",
"extension":"1888",
"type":"1"
},
{
"number":"299999999",
"ddd":"11",
"ddi":"55",
"extension":"2888",
"type":"2"
}
],
"cnpj_cpf":"12345678911",
"identification_number":"12345678"
},
"b2b_b2c":"b2b",
"sla_custom":"1",
"gift":"true",
"gift_message":"giftMessage",
"obs":"obs",
"origin":"origin",
"nationality":"nationality",
"product":"4",
"list_type_id":"1",
"list_id":"listId",
"sequential":"33",
"interest_value":"2",
"interest":"10",
"total_order_amount":"10",
"browser":{
"ip_address":"1111.222.333.444"
},
"bank_authentication":"bankAuthentication",
"sub_acquirer":"subAcquirer",
"social_network":{
"opt_in_buy_and_trust":"1",
"type_social_network":"1",
"authentication_token":"authenticationToken"
},
"voucher_order_origin":"voucherOrderOrigin",
"channel_id":"channelId"
}
}
--verbose

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"pre_authorization": {
"status": "NOV",
"nit": "73fbbb226b2e66a4a731cda5459fdca45bc371da4f76d91d53cd48035e12a102",
"order_id": "08032934333",
"merchant_usn": "8032934075",
"amount": "1000"
}
}

Ejemplo de solicitud con los demás parámetros, para iniciar una transacción de pago REST con Realtime#

Solicitud:

curl --location --request POST 'https://192.168.48.135/e-sitef/api/v1/transactions' \
--header 'Content-Type: application/json' \
--header 'merchant_id: CLEARSALERESTRT' \
--header 'merchant_key: D43B1ECD36CA0893AC6163A1913AFA084290530B861C84C672A21794CDC190C0' \
--data-raw '{
"merchant_usn": "27112936137",
"order_id": "1654629291772",
"installments": "1",
"installment_type": "4",
"authorizer_id": "2",
"amount": "3400",
"additional_data": {
"payer": {
"email": "payer@email.com",
"name": "Payer Name",
"legal_document": "7777771777"
},
"shipment": {
"type": "1",
"name": "ShipmentName",
"person": "1",
"address": {
"zip_code": "1111111",
"street_number": "111",
"street_name": "Billing StreetName",
"city": "Billing City",
"state": "Billing State",
"county": "Billing County"
}
},
"anti_fraud": "enabled_after_auth",
"billing_data": {
"person": "1",
"name": "BillingName",
"cnpj_cpf": "12345678901",
"identification_number": "12345678999",
"address": {
"zip_code": "1111111",
"street_number": "111",
"street_name": "Billing StreetName",
"city": "Billing City",
"state": "Billing State",
"county": "Billing County"
}
},
"item_amount": "11",
"origin": "origin",
"total_order_amount": "11"
}
}'

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"payment": {
"status": "NOV",
"nit": "602d8e43b33427ac2c7f3a0f136a8f763d934d395c2727d3e292a94990179f17",
"order_id": "1654629291772",
"merchant_usn": "27112936137",
"amount": "3400"
}
}