Cielo | DEUNA Docs

Nesta página

Integrar Cielo
Considerações especiais e limitantes
Recursos de teste

Esta página fornece um guia para integração da Cielo com DEUNA.

Operações Suportadas

A integração da Cielo em sua estratégia de pagamentos com DEUNA permite realizar as seguintes operações:

Autorização
Captura completa
Capturas parciais
Compra (capturada automaticamente)
Reembolso parcial (até um por pedido)
Reembolso total
Vazio
3DS DEUNA

Métodos de pagamento suportados

Cartões

Visto
Mastercard
Jantares
Amex
Elo

Países e moedas ativos

Brasil (BRL)

Requisitos

Entre em contato com seu representante Cielo e solicite as seguintes credenciais:

Suas credenciais Cielo

Integrar Cielo#

Integrar a Cielo na DEUNA.

1. Procure Cielo na DEUNA

Procure Cielo em Conexões e clique nele.

2. Configure a Cielo na sua loja

Após pesquisar pela Cielo no Connections, você deve configurar a Cielo em sua loja.

No Connections, uma janela como a seguinte será aberta:

Insira as seguintes credenciais:
- Em Nome insira um nome para fazer referência à credencial.
- Em Moeda selecione a moeda do processador do comerciante disponível.
- Em Externo Merchant ID insira o ID do comerciante externo da Cielo.
- Em Private API Key insira a chave privada da Cielo.
Escolha o tipo de operação que deseja realizar:
- Comprar
- Autorização
Escolha se deseja ativar o 3DS.
Clique Conectar.

Depois de concluir as etapas, você verá uma mensagem de sucesso.

3. Processar pagamentos com a Cielo

Você verá a conexão Cielo na guia Conexões ativas.

A partir de agora você já pode processar transações com a Cielo através da DEUNA.

Exemplo de compra v2

JSON

{
    "payer_info": {
        "email": "omar_guzhnay@gmail.com"
    },
    "order_type": "DEUNA_NOW",
    "payment_source": {
        "method_type": "credit_card",
        "card_info": {
            "expiry_month": "12",
            "expiry_year": "2026",
            "card_holder_dni": "12345678000195",
            "card_holder": "Omar Guzhnay",
            "card_number": "4024007197692931",
            "card_cvv": "123",
            "address1": "Rua Visconde de Pirajá, 123, apto 12",
            "address2": "apto 12",
            "zip": "22410001",
            "city": "MIGUEL HIDALGO",
            "state": "CIUDAD DE MÉXICO",
            "country": "BR",
            "phone": "+5511985176644",
            "installments": 1
        }
    },
    "order": {
        "order_id": "a7c1d6c6-9a36-49b1-8cee-dd5434f3d270",
        "currency": "BRL",
        "statement_descriptor":"test",
        "market_type": "ecommerce",
        "items": [
            {
                "id": "00ab2d23-f44a-4782-aa7c-bb4fadeddfe3",
                "name": "Item #1",
                "description": "Description Item #1",
                "total_amount": {
                    "original_amount": 115000,
                    "amount": 115000,
                    "total_discount": 0,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "unit_price": {
                    "amount": 100000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "tax_amount": {
                    "amount": 15000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "quantity": 1,
                "image_url": "https://cdn.prod.website-files.com/66269d6696cb4969aa25e070/662d847fb61e3145e2b2f640_Logo%20DEUNA.svg",
                "taxable": true
            },
            {
                "id": "3cb41aec-1be8-4255-a386-94bb316a8157",
                "name": "Item #2",
                "description": "Description Item #2",
                "total_amount": {
                    "original_amount": 115000,
                    "amount": 115000,
                    "total_discount": 0,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "unit_price": {
                    "amount": 100000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "tax_amount": {
                    "amount": 15000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "quantity": 1,
                "image_url": "https://cdn.prod.website-files.com/66269d6696cb4969aa25e070/662d847fb61e3145e2b2f640_Logo%20DEUNA.svg",
                "taxable": true
            }
        ],
        "sub_total": 200000,
        "tax_amount": 30000,
        "total_tax_amount": 30000,
        "total_amount": 230000,
        "store_code": "all",
        "billing_address": {
            "id": "4255",
            "first_name": "Omar",
            "last_name": "Guzhnay",
            "email": "omar_guzhnay@gmail.com",
            "address1": "Rua Visconde de Pirajá, 123, apto 12",
            "address2": "apto 12",
            "zipcode": "22410001",
            "city": "Rio de Janeiro",
            "state_code": "RJ",
            "state_name": "Rio de Janeiro",
            "country_code": "BR",
            "identity_document": "12345678000195",
            "identity_document_type": "CNPJ",
            "phone": "+5511985176644",
            "lat": -22.943934,
            "lng": -43.182984,
            "additional_description": "confirm",
            "address_type": "home"
        }
    }
}

Solicitação com tipo de iniciador

JSON

{
    "payer_info": {
        "email": "omar_guzhnay@gmail.com"
    },
    "order_type": "DEUNA_NOW",
    "payment_source": {
        "method_type": "credit_card",
        "card_info": {
            "expiry_month": "12",
            "expiry_year": "2026",
            "card_holder_dni": "12345678000195",
            "card_holder": "Omar Guzhnay",
            "card_number": "4024007197692931",
            "card_cvv": "123",
            "address1": "Rua Visconde de Pirajá, 123, apto 12",
            "address2": "apto 12",
            "zip": "22410001",
            "city": "MIGUEL HIDALGO",
            "state": "CIUDAD DE MÉXICO",
            "country": "BR",
            "phone": "+5511985176644",
            "installments": 1
        }
    },
    "order": {
        "order_id": "6eab785f-c0c6-4e04-9021-b296b8a36611",
        "currency": "BRL",
        "statement_descriptor":"test",
        "market_type": "ecommerce",
        "initiator_type": "customer", //customer or merchant
        "items": [
            {
                "id": "00ab2d23-f44a-4782-aa7c-bb4fadeddfe3",
                "name": "Item #1",
                "description": "Description Item #1",
                "total_amount": {
                    "original_amount": 115000,
                    "amount": 115000,
                    "total_discount": 0,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "unit_price": {
                    "amount": 100000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "tax_amount": {
                    "amount": 15000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "quantity": 1,
                "image_url": "https://cdn.prod.website-files.com/66269d6696cb4969aa25e070/662d847fb61e3145e2b2f640_Logo%20DEUNA.svg",
                "taxable": true
            },
            {
                "id": "3cb41aec-1be8-4255-a386-94bb316a8157",
                "name": "Item #2",
                "description": "Description Item #2",
                "total_amount": {
                    "original_amount": 115000,
                    "amount": 115000,
                    "total_discount": 0,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "unit_price": {
                    "amount": 100000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "tax_amount": {
                    "amount": 15000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "quantity": 1,
                "image_url": "https://cdn.prod.website-files.com/66269d6696cb4969aa25e070/662d847fb61e3145e2b2f640_Logo%20DEUNA.svg",
                "taxable": true
            }
        ],
        "sub_total": 200000,
        "tax_amount": 30000,
        "total_tax_amount": 30000,
        "total_amount": 230000,
        "store_code": "all",
        "billing_address": {
            "id": "4255",
            "first_name": "Omar",
            "last_name": "Guzhnay",
            "email": "omar_guzhnay@gmail.com",
            "address1": "Rua Visconde de Pirajá, 123, apto 12",
            "address2": "apto 12",
            "zipcode": "22410001",
            "city": "Rio de Janeiro",
            "state_code": "RJ",
            "state_name": "Rio de Janeiro",
            "country_code": "BR",
            "identity_document": "12345678000195",
            "identity_document_type": "CNPJ",
            "phone": "+5511985176644",
            "lat": -22.943934,
            "lng": -43.182984,
            "additional_description": "confirm",
            "address_type": "home"
        }
    }
}

Solicitação com recorrência

JSON

{
    "payer_info": {
        "email": "omar_guzhnay@gmail.com"
    },
    "order_type": "DEUNA_NOW",
    "payment_source": {
        "method_type": "credit_card",
        "card_info": {
            "expiry_month": "12",
            "expiry_year": "2026",
            "card_holder_dni": "12345678000195",
            "card_holder": "Omar Guzhnay",
            "card_number": "4024007197692931",
            "card_cvv": "123",
            "address1": "Rua Visconde de Pirajá, 123, apto 12",
            "address2": "apto 12",
            "zip": "22410001",
            "city": "MIGUEL HIDALGO",
            "state": "CIUDAD DE MÉXICO",
            "country": "BR",
            "phone": "+5511985176644",
            "installments": 1
        }
    },
    "order": {
        "order_id": "6eab785f-c0c6-4e04-9021-b296b8a36611",
        "currency": "BRL",
        "statement_descriptor":"test",
        "market_type": "ecommerce",
        "recurrence": {
            "first_time_use": true   //true = first or false=subsequent
        },
        "items": [
            {
                "id": "00ab2d23-f44a-4782-aa7c-bb4fadeddfe3",
                "name": "Item #1",
                "description": "Description Item #1",
                "total_amount": {
                    "original_amount": 115000,
                    "amount": 115000,
                    "total_discount": 0,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "unit_price": {
                    "amount": 100000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "tax_amount": {
                    "amount": 15000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "quantity": 1,
                "image_url": "https://cdn.prod.website-files.com/66269d6696cb4969aa25e070/662d847fb61e3145e2b2f640_Logo%20DEUNA.svg",
                "taxable": true
            },
            {
                "id": "3cb41aec-1be8-4255-a386-94bb316a8157",
                "name": "Item #2",
                "description": "Description Item #2",
                "total_amount": {
                    "original_amount": 115000,
                    "amount": 115000,
                    "total_discount": 0,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "unit_price": {
                    "amount": 100000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "tax_amount": {
                    "amount": 15000,
                    "currency": "BRL",
                    "currency_symbol": "R$"
                },
                "quantity": 1,
                "image_url": "https://cdn.prod.website-files.com/66269d6696cb4969aa25e070/662d847fb61e3145e2b2f640_Logo%20DEUNA.svg",
                "taxable": true
            }
        ],
        "sub_total": 200000,
        "tax_amount": 30000,
        "total_tax_amount": 30000,
        "total_amount": 230000,
        "store_code": "all",
        "billing_address": {
            "id": "4255",
            "first_name": "Omar",
            "last_name": "Guzhnay",
            "email": "omar_guzhnay@gmail.com",
            "address1": "Rua Visconde de Pirajá, 123, apto 12",
            "address2": "apto 12",
            "zipcode": "22410001",
            "city": "Rio de Janeiro",
            "state_code": "RJ",
            "state_name": "Rio de Janeiro",
            "country_code": "BR",
            "identity_document": "12345678000195",
            "identity_document_type": "CNPJ",
            "phone": "+5511985176644",
            "lat": -22.943934,
            "lng": -43.182984,
            "additional_description": "confirm",
            "address_type": "home"
        }
    }
}

Considerações especiais e limitantes#

Endereço de cobrança

As transações nacionais adquiridas pela Cielo deverão incluir as seguintes informações do shopper na solicitação de autorização:

billing_address.zipcode
billing_address.state_name
billing_address.country_code

Isto segue a regulamentação local para retenção de impostos na província do comprador. Quando esses dados não são fornecidos, a Cielo retém o imposto com base na localização do estabelecimento.

Envie um dos códigos:

Código da província COMARB	Código da província ISO	Nome da província
901	AR-C	CABA
909	AR-P	Formosa
919	AR-D	São Luís
908	AR-E	Entre Rios
911	AR-L	La Pampa
917	AR-A	Salta
906	AR-H	Chaco
907	AR-U	Chubut
910	AR-Y	Jujuy
920	AR-Z	Santa Cruz
903	AR-K	Catamarca
904	AR-X	Córdoba
912	AR-F	La Rioja
922	AR-G	Santiago del Estero
918	AR-J	São João
913	AR-M	Mendoza
914	AR-N	Missões
915	AR-Q	Neuquén
916	AR-R	Rio Negro
923	AR-V	Terra do Fogo
902	AR-B	Buenos Aires
921	AR-S	Santa Fé
924	AR-T	Tucumán
905	AR-W	Corrientes

Código da moeda: especifica o código da moeda (ISO 4217) do país relevante.
Código do país: especifica o Códigos de país ISO
O número de parcelas é validado em relação ao número máximo de parcelas acordado com o adquirente.
Um pagamento que é AUTHORIZED pode ser capturado.
Uma captura parcial pode ser realizada, se necessário.
Cada pagamento autorizado permite uma captura parcial ou total.
Recomenda-se capturar um pedido no prazo de 5 dias após a autorização para evitar a expiração.
Um reembolso só pode ser solicitado após o pagamento chegar ao CAPTURED status.
Os reembolsos não podem exceder o valor original capturado, mas podem ser realizados um ou mais reembolsos parciais do valor capturado.
Apenas um reembolso parcial pode ser enviado por pedido.
Um pagamento só pode ser cancelado (Anulado) depois de atingir o AUTHORIZED status.
O cancelamento não é mais possível quando o pagamento chega ao CAPTURED status.
O cancelamento total (anulado) pode ser enviado por pedido.
O initiator type O campo é crucial para indicar quem iniciou a transação, o que tem implicações no fluxo da transação e melhora a taxa de conversão. Os dois valores possíveis são:
1. customer: Este valor refere-se a uma transação onde o titular do cartão (o cliente) está presente e interage para iniciar a compra.
2. merchant: Este valor refere-se a uma transação em que o estabelecimento comercial (ou prestador de serviço) inicia a utilização do cartão armazenado no cliente, sem interação direta com o cliente naquele momento.
Encomendas com o recurrence objeto apresentar diferenciação entre o primeiro pagamento e os subsequentes.
1. O primeiro pagamento é categorizado por tipo recurrence.first_time_use = true.
2. Os pagamentos subsequentes são identificados pelo tipo recurrence.first_time_use = false.
3. Nota: A adição do parâmetro recurrence.first_time_use não está vinculado ou condicionado à API de Pagamento Recorrente.
Antes de aceitar pagamentos na América Latina, é necessária uma entidade legal e um adquirente no país de operação

Recursos de teste#

Credenciais da Cielo

ABAP

External Merchant ID: 8937bd5b-9796-494d-9fe5-f76b3e4da633
Private API Key: XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV

Coleção do Postman

Solicite o ambiente e coleção atual do Cielo Postman à sua equipe de integração DEUNA.

Cartões de teste

Marca	Tipo	Número do cartão	Mês de vencimento	Ano de expiração	CVV
Visto	Aprovado	4024007197692931	12	2026	123
Mestre	Aprovado	5555666677778884	12	2026	123
Visto	Rejeitado	4000000000002503	12	2026	123
Mestre	Rejeitado	5200000000002235	12	2026	123