Create carnê transaction

post https://apisandbox.cieloecommerce.cielo.com.br/1/sales/

Create an carnê transaction.

Environment	Method	Endpoint
Sandbox	post	`https://apisandbox.cieloecommerce.cielo.com.br/1/sales/`
Production	post	`https://api.cieloecommerce.cielo.com.br/1/sales/`

The Carnê is a debit transaction used to pay a bill.

The carnê is a valid payment method for MasterCard, Visa, and Elo brands.

This modality can be used by merchants who issue their own carnê and Private Label card invoices. The carnê product allows for the separation of sales related to product purchases and service payments, facilitating the reporting of amounts to the tax authorities.

Like any debit transaction in e-commerce, carnê transactions need to be authenticated via the 3DS 2.2 protocol. Get more information about the authentication protocol in the 3DS 2.2 manual.

Body Params

MerchantOrderId

string

required

Order identification number. Warning: Allowed characters are a-z, A-Z, 0-9. Special characters and blank spaces are not allowed. Size: 50.

Customer

object

Payment

object

Headers

Content-Type

string

Defaults to application/json

Size: 40.

MerchantId

string

required

Defaults to 8937bd5b-9796-494d-9fe5-f76b3e4da633

Store identifier in API E-commerce Cielo. Size: 36. This documentation provides a default MerchantId to allow testing in the sandbox, but you can also provide the enabled MerchantId during the deployment process.

MerchantKey

string

required

Defaults to XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV

Public Key for Double Authentication in API E-commerce Cielo. Size: 40. This documentation provides a default MerchantKey to allow testing in the sandbox, but you can also provide the enabled MerchantKey during the deployment process.

RequestId

string

Request Identifier, used when the merchant uses different servers for each GET/POST/PUT. Size: 36.

Response

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://apisandbox.cieloecommerce.cielo.com.br/1/sales/ \
3
     --header 'Content-Type: application/json' \
4
     --header 'MerchantId: 8937bd5b-9796-494d-9fe5-f76b3e4da633' \
5
     --header 'MerchantKey: XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV' \
6
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200