Articles in this section

Set up a connection to Cielo

Tanisha Ray
Updated

Cielo is a leading payment processor, offering a robust technology backbone including AI-powered fraud detection, real-time analytics, and a high-throughput API ecosystem designed for speed and scalability.

Set up a connection

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

Setting

Instructions

Name your connection * 

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

API type *

Choose your Cielo account API type:

  • Transactional: Process payments in real time, capture authorizations, manage refunds, and execute recurring transactions to power secure and seamless digital checkout experiences that boost conversion and customer satisfaction.

  • Query: Retrieve detailed transaction data, monitor payment statuses, and audit operational activity to ensure transparency, streamline reporting, and enable timely resolution of customer issues across channels.

  • Protected card: Safely store and manage customer card details through tokenization, reducing PCI scope while enabling faster repeat purchases, enhanced security, and smoother customer journeys across payment touchpoints.

Environment *

Select your Cielo account environment:

  • Production:

    • Transactional: If your account URL is https://api.braspag.com.br/

    • Query: If your account URL is https://apiquery.braspag.com.br/

    • Protected card: If your account URL is https://cartaoprotegidoapi.braspag.com.br/

  • Sandbox:

    • Transactional: If your account URL is https://apisandbox.braspag.com.br/

    • Query: If your account URL is https://apiquerysandbox.braspag.com.br/

    • Protected card: If your account URL is https://cartaoprotegidoapisandbox.braspag.com.br/

Merchant ID *

Enter your Cielo merchant ID.

dataLoad.svg​​How to retrieve the merchant ID

Merchant key *

Enter your Cielo merchant key.

Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s key safe. When editing this form later, you must enter this token again; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​How to retrieve the merchant key

API type: Transactional

Card ID *

Enter your Cielo card ID.

API type: Query

Payment ID *

Enter your Cielo payment ID.

API type: Protected card

Token reference *

Enter your Cielo account token reference.

Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s token safe. When editing this form later, you must enter this token again; it is stored only when the connection is saved and never displayed as text.

OAuth 2.0 client *

Select the OAuth 2.0 client that stores the client ID and client secret provided to you by Cielo.

dataLoad.svg​​How to retrieve the client ID and client secret

To add an OAuth 2.0 client and configure your credentials, click the plus (+) button. Click the edit (pencil.svg) button to modify a selected OAuth 2.0 client. For more information, see Create an OAuth 2.0 iClient resource.

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see custom, and OAuth 2.0 universal connector documentation respectively.

How to retrieve the merchant ID and merchant key

  1. Sign in to your Cielo account.

  2. Enter the EC number and click Enter.

    Note

    You can find the EC number of the Cielo E-commerce API in the welcome email sent by Cielo.

  3. Navigate to My establishments > See more > Access.

  4. Navigate to E-commerce > Access > View.

  5. Enter the token sent to you via email or the Cielo management app.

  6. Click Authenticate.

  7. Copy the Merchant ID.

  8. Copy the Merchant key.

How to retrieve the client ID and client secret

  1. Sign in to your Cielo account.

  2. Navigate to E-commerce > Payment link > My links > Settings > Registration data if you are using the Payment link.

    – or – 

    Navigate to E-commerce > Checkout > Access > Settings > Registration data if you are using the Checkout.

  3. Click Generate payment link.

  4. Enter the required details.

  5. Click Save.

  6. Click Generate API access credentials. An email with the required details will be sent to you.

  7. Copy the Client ID.

  8. Copy the Client secret.

Additional references