Primeiro uso do cartão armazenado

O exemplo abaixo mostra como utilizar a funcionalidade Card on File quando o cartão está sendo armazenado pela primeira vez.
Esse processo permite que o cartão seja reutilizado em transações futuras, oferecendo mais praticidade e segurança para a pessoa usuária.

ℹ️
Saiba mais sobre essa funcionalidade na documentação.

post

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.cieloecommerce.cielo.com.br/1/sales`
Produção	post	`https://api.cieloecommerce.cielo.com.br/1/sales`

Requisição

{  
   "MerchantOrderId":"2014111701",
   "Customer":{  
      "Name":"Aline de Souza",
      "Email":"[email protected]",
      "Birthdate":"1990-01-01"
   },
   "Payment":{  
     "Type":"CreditCard",
     "Amount":15700,
     "Currency":"BRL",
     "Country":"BRA",
     "Installments":1,
     "Capture":true,
     "SoftDescriptor":"123456789ABCD",
     "CreditCard":{  
         "CardNumber":"4091688625337641",
         "Holder":"Teste Holder",
         "ExpirationDate":"12/2035",
         "SecurityCode":"333",
         "SaveCard":"false",
         "Brand":"Visa",
         "CardOnFile":{
            "Usage": "First"
         }
     }
   }
}

PROPRIEDADE	TIPO	TAMANHO	OBRIGATÓRIO	DESCRIÇÃO
`MerchantOrderId`	Texto	50	Sim	Número de identificação do pedido. Atenção: Os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco.
`Customer.Name`	Texto	255	Não	Nome do comprador. Atenção: Os caracteres permitidos são apenas a-z, A-Z. Não são permitidos caracteres especiais e números.
`Customer.Email`	Texto	255	Não	E-mail do comprador.
`Customer.Birthdate`	Date	10	Não	Data de nascimento do comprador (AAAA/MM/DD).
`Payment.Type`	Texto	100	Sim	Tipo do meio de pagamento.
`Payment.Amount`	Número	15	Sim	Valor do pedido (ser enviado em centavos).
`Payment.Currency`	Texto	3	Não	Moeda na qual o pagamento será feito (BRL).
`Payment.Country`	Texto	3	Não	País na qual o pagamento será feito.
`Payment.SoftDescriptor`	Texto	13	Não	O complemento do nome da loja que aparecerá na fatura do cartão. Não permite caracteres especiais.
`Payment.Installments`	Número	2	Sim	Número de parcelas. Se a transação for uma recorrência, o número de parcelas será 1. Para transações parceladas, o número de parcelas será sempre maior que 1.
`Payment.Capture`	Booleano	—	Não (Default false)	Booleano que identifica que a autorização deve ser com captura automática (“true”) ou captura posterior (“false”).
`CreditCard.CardNumber`	Texto	19	Sim	Número do cartão do comprador.
`CreditCard.Holder`	Texto	25	Sim	Nome do comprador impresso no cartão. Não aceita caracteres especiais ou acentuação.
`CreditCard.ExpirationDate`	Texto	7	Sim	Data de validade impressa no cartão. Ex. MM/AAAA.
`CreditCard.SecurityCode`	Texto	4	Não	Código de segurança impresso no verso do cartão.
`CreditCard.SaveCard`	Booleano	—	Não (Default false)	Booleano que identifica se o cartão será salvo para gerar o `CardToken`. Saiba mais sobre Tokenização
`CreditCard.Brand`	Texto	10	Sim	Bandeira do cartão. Valores possíveis: Visa / Master / Amex / Elo / Aura / JCB / Diners / Discover.
`CreditCard.CardOnFile.Usage`	Texto		Não	"First" se o cartão foi armazenado e é seu primeiro uso. "Used" se o cartão foi armazenado e ele já foi utilizado anteriormente em outra transação

Resposta

{
    "MerchantOrderId": "2014111701",
    "Customer":{  
      "Name":"Aline de Souza",
      "Email":"[email protected]",
      "Birthdate":"1990-01-01"
   },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": 0,
        "Capture": true,
        "CreditCard": {
            "CardNumber": "4091688625337641",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2035",
            "SaveCard": false,
            "Brand": "Visa",
            "CardOnFile": {
                "Usage": "First"               
            },
            "PaymentAccountReference": "JZHOZJHNZH87KQXM3G60B9I21GVZN"
        },
        "Tid": "0928084922246",
        "ProofOfSale": "652515",
        "AuthorizationCode": "927181",
        "SoftDescriptor": "123456789ABCD",
        "Provider": "Simulado",
        "IsQrCode": false,
        "DynamicCurrencyConversion": false,
        "Amount": 15700,
        "ReceivedDate": "2022-09-28 08:49:22",
        "CapturedAmount": 15700,
        "CapturedDate": "2022-09-28 08:49:22",
        "Status": 2,
        "IsSplitted": false,
        "ReturnMessage": "Operation Successful",
        "ReturnCode": "6",
        "PaymentId": "91bad53a-9198-4738-a280-f51dddc34988",
        "Type": "CreditCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/91bad53a-9198-4738-a280-f51dddc34988"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/91bad53a-9198-4738-a280-f51dddc34988/void"
            }
        ]
    }
}

PROPRIEDADE	DESCRIÇÃO	TIPO	TAMANHO	FORMATO
`ProofOfSale`	Número da autorização, identico ao NSU.	Texto	6	Texto alfanumérico
`Tid`	Id da transação na adquirente.	Texto	20	Texto alfanumérico
`AuthorizationCode`	Código de autorização.	Texto	6	Texto alfanumérico
`SoftDescriptor`	Texto impresso na fatura bancária do portador. Não permite caracteres especiais.	Texto	13	Texto alfanumérico
`PaymentId`	Número de identificação do pagamento, necessário para futuras operações como Consulta, Captura e Cancelamento.	Guid	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
`ECI`	Eletronic Commerce Indicator. Representa o quão segura é uma transação.	Texto	2	Exemplo: 7
`Status`	Status da Transação.	Byte	—	2
`ReturnCode`	Código de retorno da Adquirência.	Texto	32	Texto alfanumérico
`ReturnMessage`	Mensagem de retorno da Adquirência.	Texto	512	Texto alfanumérico
`Payment.MerchantAdviceCode`	Código de retorno da bandeira que define período para retentativa. Válido somente para bandeira Mastercard. Saiba mais em Programa de Retentativa das Bandeiras Mastercard	Texto	2	Numérico
`CreditCard.PaymentAccountReference`	O PAR (Payment Account Reference) é o número que associa diferentes tokens a um mesmo cartão. Será retornado pelas bandeiras Master e Visa e repassado para os clientes do e-commerce Cielo. Caso a bandeira não envie a informação o campo não será retornado.	Alfanumérico	29	—

ℹ️
Para a bandeira Mastercard é necessário enviar o nó Payment.InitiatedTransactionIndicator para indicar o iniciador de transação.