Create payment with currency conversion

Creates a payment with a foreign credit card requesting currency conversion

ℹ️

Learn more about this feature in the documentation.

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.cieloecommerce.cielo.com.br/1/sales
Produçãohttps://api.cieloecommerce.cielo.com.br/1/sales

Request will be the same as a standard credit transaction, with the addition of the DynamicCurrencyConversion field set to true.

Response will return the CurrencyExchangeData node, which contains the conversion options:

  • Amount (ConvertedAmount);
  • Rate (ConversionRate);
  • Local currency (Currency).
"CurrencyExchangeData": {
      "CurrencyExchanges": [
        {
          "ConvertedAmount": 21,
          "ConversionRate": 0.2124,
          "Currency": "USD"
        }
      ]
}

Status 12: indicates that the transaction is pending, waiting for a confirmation request from the merchant to proceed with the transaction.

Merchant must prepare the checkout page to present a screen with the currency conversion options to shopper, based on the options returned in the CurrencyExchangeData node.

ℹ️

Attention: Example on this page shows the necessary parameters for Conversor de moedas e-commerce and only the mandatory parameters for a credit card transaction. To check all possible parameters, go to Create payment with credit card.

Body Params
string
required

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

Customer
object
Payment
object
boolean
required

Send as true to request the conversion of the order amount to the local currency of the foreign credit card used for the purchase.

Headers
string
required
Defaults to 8937bd5b-9796-494d-9fe5-f76b3e4da633

Store identifier in Cielo. Size: 36.

string
required
Defaults to XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV

Public Key for Double Authentication in Cielo. Size: 40.

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

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json