Criar pagamento recorrente com cartão tokenizado

É possível criar uma transação recorrente com um cartão de crédito que já está armazenado (tokenizado).

Meio de pagamento aceito: cartão de crédito.

Requisição

{
  "MerchantOrderId": "Loja123456",
  "Customer": {
    "Name": "Aline de Souza"
  },
  "Payment": {
    "Type": "CreditCard",
    "Amount": 1500,
    "Installments": 1,
    "Capture": true,
    "SolutionType": "ExternalLinkPay",
    "RecurrentPayment": {
      "AuthorizeNow": "true",
      "EndDate": "2030-10-01",
      "Interval": "Monthly"
    },
    "CreditCard": {
      "CardToken": "4086baad-a31c-48b9-830d-8596bfe9c33c",
      "Brand": "Visa",
      "SecurityCode": "123",
    }
  }
}

Parâmetros no header

Parâmetros no body

  <th>
    Descrição
  </th>

  <th>
    Tipo
  </th>

  <th>
    Tamanho
  </th>

  <th>
    Obrigatório
  </th>
</tr>

  <td>
    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.*
  </td>

  <td>
    Texto
  </td>

  <td>
    50
  </td>

  <td>
    Sim
  </td>
</tr>

<tr>
  <td>
    `Customer.Name`
  </td>

  <td>
    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.*
  </td>

  <td>
    Texto
  </td>

  <td>
    255
  </td>

  <td>
    Sim
  </td>
</tr>

<tr>
  <td>
    `Payment.Type`
  </td>

  <td>
    Tipo do meio de pagamento.
  </td>

  <td>
    Texto
  </td>

  <td>
    100
  </td>

  <td>
    Sim
  </td>
</tr>

<tr>
  <td>
    `Payment.Amount`
  </td>

  <td>
    Valor do pedido (ser enviado em centavos).
  </td>

  <td>
    Número
  </td>

  <td>
    15
  </td>

  <td>
    Sim
  </td>
</tr>

<tr>
  <td>
    `Payment.Installments`
  </td>

  <td>
    Número de parcelas. Como se trata de uma recorrência, o número de parcelas será 1.
  </td>

  <td>
    Número
  </td>

  <td>
    2
  </td>

  <td>
    Sim
  </td>
</tr>

<tr>
  <td>
    `Payment.Capture`
  </td>

  <td>
    Booleano que identifica que a autorização deve ser com captura automática (“true”) ou captura posterior (“false”).
  </td>

  <td>
    Boolean
  </td>

  <td>
    *
  </td>

  <td>
    Não (default: *false*)
  </td>
</tr>

<tr>
  <td>
    `Payment.SoftDescriptor`
  </td>

  <td>
    Texto que será impresso na fatura bancária do portador.\
    Disponível apenas para Visa e Mastercard - não permite caracteres especiais.
  </td>

  <td>
    Texto
  </td>

  <td>
    13
  </td>

  <td>
    Não
  </td>
</tr>

<tr>
  <td>
    `Payment.RecurrentPayment`
  </td>

  <td>
    Indica que uma transação é de recorrência própria.
  </td>

  <td>
    Boolean
  </td>

  <td>
    5
  </td>

  <td>
    Sim\*       \|
  </td>
</tr>

<tr>
  <td>
    `Payment.SolutionType`
  </td>

  <td>
    Origem do pagamento. **Obrigatório para transação de cartão da bandeira Elo oriunda de link de pagamento**. <br />Enviar como *"ExternalLinkPay"*. 
  </td>

  <td>
    String
  </td>

  <td>
    15
  </td>

  <td>
    Não
  </td>
</tr>

<tr>
  <td>
    `CreditCard.CardNumber`
  </td>

  <td>
    Número do cartão do comprador.
  </td>

  <td>
    Texto
  </td>

  <td>
    19
  </td>

  <td>
    Sim
  </td>
</tr>

<tr>
  <td>
    `CreditCard.Holder`
  </td>

  <td>
    Nome do comprador impresso no cartão.
  </td>

  <td>
    Texto
  </td>

  <td>
    25
  </td>

  <td>
    Sim
  </td>
</tr>

<tr>
  <td>
    `CreditCard.ExpirationDate`
  </td>

  <td>
    Data de validade impressa no cartão.
  </td>

  <td>
    Texto
  </td>

  <td>
    7
  </td>

  <td>
    Sim
  </td>
</tr>

<tr>
  <td>
    `CreditCard.SecurityCode`
  </td>

  <td>
    Código de segurança impresso no verso do cartão.
  </td>

  <td>
    Texto
  </td>

  <td>
    4
  </td>

  <td>
    Não
  </td>
</tr>

<tr>
  <td>
    `CreditCard.Brand`
  </td>

  <td>
    Bandeira do cartão.
  </td>

  <td>
    Texto
  </td>

  <td>
    10
  </td>

  <td>
    Sim
  </td>
</tr>

Parâmetro
`MerchantOrderId`

Resposta

{
  "MerchantOrderId": "Loja123456",
  "Customer": {
    "Name": "Aline de Souza"
  },
  "Payment": {
    "Installments": 1,
    "Capture": true,
    "CreditCard": {
      "CardToken": "4086baad-a31c-48b9-830d-8596bfe9c33c",
      "Brand": "Visa",
      "SecurityCode": "123",
    },
    "ProofOfSale": "3827556",
    "Tid": "0504043827555",
    "AuthorizationCode": "149867",
    "PaymentId": "737a8d9a-88fe-4f74-931f-acf81149f4a0",
    "Type": "CreditCard",
    "Amount": 1500,
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "SolutionType": "ExternalLinkPay",
    "ExtraDataCollection": [],
    "Status": 1,
    "ReturnCode": "4",
    "ReturnMessage": "Operation Successful",
    "RecurrentPayment": {
      "RecurrentPaymentId": "61e5bd30-ec11-44b3-ba0a-56fbbc8274c5",
      "NextRecurrency": "2025-03-04",
      "EndDate": "2030-12-01",
      "Interval": "Monthly",
      "Link": {
        "Method": "GET",
        "Rel": "recurrentPayment",
        "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}"
      },
      "AuthorizeNow": true
    },
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void"
      }
    ]
  }
}