Confirm the currency conversion

put

https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/confirm

Confirms the conversion of the payment from reais to the foreign card currency

ℹ️
Learn more about this feature in the documentation.

Environment	Method	Endpoint
Sandbox	put	`https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/confirm`
Production	put	`https://api.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/confirm`

After shopper decides to pay in the foreign currency, merchant must send the conversion confirmation request with the CurrencyConversion field set to true. After confirmation, API E-commerce Cielo will submit the transaction for authorization.

⚠️
Warning to the confirmation time limit
Confirmation must be done within twenty minutes.
If the time for confirming the desired currency exceeds twenty minutes, the API will return code 020 with the message “Status does not allow authorization”.
If the capture is not automatic (Payment.Capture set to true), the subsequent capture must also be done within 20 minutes to guarantee the exchange rate for shopper.

Path Params

PaymentId

string

required

Id of the transaction at the acquirer, returned in the response to the conversion step.

Body Params

CurrencyConversion

boolean

required

Boolean that confirms the buyer has opted to perform the conversion. When true, it indicates that the transaction will be submitted for authorization in the foreign currency. When false, it indicates that the transaction will be submitted for authorization in Brazilian reais.

Headers

MerchantId

string

required

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

Store identifier in 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 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.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Warning to the confirmation time limit

200200

400400