Salvar cartão durante a autorização

Split de Pagamento com a solução de captura API E-commerce Cielo

Para salvar um cartão de crédito durante a autorização da transação, envie o parâmetro Payment.SaveCard como "true" na requisição padrão de cartão de crédito.

ℹ️

Os cartões são salvos de maneira tokenizada;

A numeração do cartão precisa ser válido de acordo com o algoritmo de Luhn (mod10).

Requisição

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`

--header "Authorization: Bearer {access_token}"

{  
   "MerchantOrderId":"2017051001",
   "Customer":{  
      "Name":"Nome do Comprador",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Email":"[email protected]",
      "Birthdate":"1991-01-02",
      "IpAddress":"127.0.0.1",
      "Address":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
      },
      "DeliveryAddress":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
      }
   },
   "Payment":{  
      "Type":"CreditCard",
      "Amount":10000,
      "Currency":"BRL",
      "Country":"BRA",
      "Installments":1,
      "Capture":true,
      "Authenticate":false,
      "Recurrent":false,
      "SoftDescriptor":"Mensagem",
      "CreditCard":{  
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa",
         "SaveCard":true,
         "Alias":"",
       }
   }
}

Parâmetros no header

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
Authorization Bearer:`access_token`	String	--	Sim	Token de acesso. Informe o `access_token` obtido para a autenticação OAuth2

Parâmetros no body

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
`Payment.Provider`	Nome do provedor do meio de pagamento.	Texto	15	Sim
`Payment.Type`	Tipo do meio de pagamento.	Texto	100	Sim
`Payment.Amount`	Valor do pedido, em centavos.	Número	15	Sim
`Payment.Installments`	Número de parcelas.	Número	2	Sim
`CreditCard.CardNumber`	Número do cartão do comprador.	Texto	16	Sim
`CreditCard.Holder`	Nome do comprador impresso no cartão. Obs.: Regras de tamanho do campo podem variar de acordo com a adquirente.	Texto	25	Sim
`CreditCard.ExpirationDate`	Data de validade impressa no cartão, no formato MM/AAAA.	Texto	7	Sim
`CreditCard.SecurityCode`	Código de segurança impresso no verso do cartão.	Texto	4	Sim
`CreditCard.Brand`	Bandeira do cartão.	Texto	10	Sim
`CreditCard.SaveCard`	"true" - para salvar o cartão. / "false" - para não salvar o cartão.	Booleano	10	Não (default "false")
`CreditCard.Alias`	Alias (apelido) do cartão de crédito.	Texto	64	Não

Resposta

O parâmetro CreditCard.CardToken retornará o token a ser salvo para transações futuras com o mesmo cartão.

{
  [...]
  },
    "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": true,
      "CardToken": "250e7c7c-5501-4a7c-aa42-a33d7ad61167",
      "Brand": "Visa",
      "Alias": "Cliente1"
    },
    "ProofOfSale": "3519928",
    "AcquirerTransactionId": "0511023519928",
    "AuthorizationCode": "536934",
    "PaymentId": "3af00b2d-dbd0-42d6-a669-d4937f0881da",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 14:35:19",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    [...]
  }
}

Propriedade	Descrição	Tipo	Tamanho	Formato
`AcquirerTransactionId`	Id da transação no provedor do meio de pagamento.	Texto	40	Texto alfanumérico
`ProofOfSale`	Número do comprovante de venda.	Texto	20	Texto alfanumérico
`AuthorizationCode`	Código de autorização.	Texto	300	Texto alfanumérico
`PaymentId`	Campo identificador do pedido.	GUID	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
`ReceivedDate`	Data em que a transação foi recebida pelo Split.	Texto	19	AAAA-MM-DD HH:mm:SS
`ReasonCode`	Código de retorno da operação.	Texto	32	Texto alfanumérico
`ReasonMessage`	Mensagem de retorno da operação.	Texto	512	Texto alfanumérico
`Status`	Status da transação.	Byte	2	Ex.: 1
`ProviderReturnCode`	Código retornado pelo provedor do meio de pagamento (adquirente ou emissor).	Texto	32	57
`ProviderReturnMessage`	Mensagem retornada pelo provedor do meio de pagamento (adquirente ou emissor).	Texto	512	Transação Aprovada
`CreditCard.CardToken`	Token no Cartão Protegido que representa os dados do cartão.	GUID	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx