Histórico da Página

É um recurso amplamente utilizado no e-commerce para agilizar o processo de compra, sem comprometer a segurança dos dados do consumidor.
Como a tokenização funciona? A tokenização é um código gerado por algoritmos que substitui as informações sensíveis dos consumidores que estão armazenadas em uma base de dados.

Requisitos:

Para utilizar nossa API é necessário que você tenha familiaridade com a terminologia básica utilizada no desenvolvimento de web services REST. É possível desenvolver a integração com praticamente todas as linguagens de programação disponíveis no mercado. Abaixo seguem os nomes das entidades que serão mencionadas nessa documentação e suas especificações.

Ter realizado o procedimento de criação do Customers, API Customer;
Armazene o Id do Payload do Customers, ele será utilizado no procedimento de criação da Tokenização;
Possuir acesso ao Swagger.

Subscrição com dados de pagamento

O método de de subscrição permite que seja registrada informações para a realização de uma adesão contendo informações do cliente e cartão tokenizado.

Card

label	Tokenização do cartão de crédito

Card

label	Tokenização do cartão de crédito

Deck of Cards

id	Subscriptions

Card

label	CustomerEndpoint Payment-Token

Esse método permite registrar guardar as informações do cliente cartão para que seja associado na subscrição nova ou já registrado.

Endpoint de homologação

https://api-recorrencia.staging.totvs.app/api/v1/customers

utilizado no processo de adesão.

Obs.: Todas as informações das requisições são fictícias e não teram valor de processamento.

Procedimento de criação da tokenização do cartão.

Usando o POST Payment-Token para associar o id do Customers.

Insira o id do Customers nesse exemplo iremos utilizar o 4292.....Parâmetros de Entrada

Bloco de código

language	yml
title	POST Customerspayment-token

{
  "codecustomerId": "123456", //Identificador do cliente
  "reference": "00010020",429203e1-3261-45a7-b83c-9eb78deb9fca" //Id códigogerado externo
  "name": "TOTVs", //Nomena criação do cliente
  "typeDocument": "1 = NaturalPerson", //Tipo de documento 1=NaturalPerson;2=LegalPerson
  "documentNumber": "308540", //Número do documento
  "status": "1 = Active",
  "addresses": [
    {
      "type": "1 = Home", //Tipo de endereço 1=Home;2=Business;3=Billing  
      "street": "Rua Dom Pedro I", //Endereço
      "number": "100", //Número
      "complement": "Bloco B", // Complemento
      "district": "Bairro Jardim", //Bairro
      "zipCode": "00000-000", //CEP
      "cityName": "São Paulo", //Cidade
      "stateInitials": "SP", //Estado
      "stateName": "São Paulo", //Nome Estado
      "countryName": "Brasil" //País
    }
  ],
  "emails": [
    {
      "type": "1 = Personal", // Tipo de pessoa 1=Personal;2=Work;3=Home;4=Business;5=Billing 
      "emailAddress": "[email protected]" //email de contato
    }
  ],
  "phones": [
    {
      "type": "1 = Home", //Tipo 1=Home;2=Business;3=CellPhone
      "countryCode": "+55", //Código do país
      "areaCode": "11", //Código da area
      "number": "(11)91111-1111", //Número
      "extension": "2666" //Ramal
    }
  ],
  "birthDate": "01/01/2001", //Data de nascimento
}

Parâmetros de Saída

Customers
}

Parâmetros de Saída

Armazena o Id disponibilizado no campo url: e5ceab4d-f0d9-484b-a6cb-d3b8ee8ca639

Bloco de código

language	yml
title	POST CustomersRESPONSE Payment-Token

{
    "id": "9495d9dae5ceab4d-33bef0d9-4634484b-a67ea6cb-22eced59274dd3b8ee8ca639",
    "integrationIdstatus": "T1|D MG 01|0021878Received",
  "code": "123456",
  "organizationIdurl": "9495d9da-33be-4634-a67e-22eced59274d",
  "organizationIntegrationId": "T1|D MG 01",
  "reference": "00010020",
  "name": "TOTVs",
  "typeDocument": "1 = NaturalPerson",
  "documentNumber": "308540",
  "stateRegistration": "000.000.000.000",
  "cityRegistration": "000000-0",
  "status": "1 = Active",
  "birthDate": "01/01/2001",
  "isActive": true
}/api/v1/payment-token/e5ceab4d-f0d9-484b-a6cb-d3b8ee8ca639",
    "date": "2023-09-27T19:15:29.3039488+00:00"
}

Coletando o id para realizar a gravação do cartão.

Parâmetros de Entrada

Cole o id do campo url logo após o nome payment-token, exemplo abaixo:Parâmetros de Entrada

Bloco de código

language	yml
title	GET CustomersPayment-Token

https://api-recorrencia.staging.totvs.app/api/v1/rac/customers/{id}payment-token/e5ceab4d-f0d9-484b-a6cb-d3b8ee8ca639

Parâmetros de Saída

Bloco de código

language	yml
title	GET CustomersRESPONSE Payment-Token

{
    "id": "9495d9dae5ceab4d-33bef0d9-4634484b-a67ea6cb-22eced59274dd3b8ee8ca639",
    "integrationIdcustomerId": "T1|D MG 01|0021878429203e1-3261-45a7-b83c-9eb78deb9fca",
    "codenickname": "123456"null,
    "organizationIdlastFourDigits": "9495d9da-33be-4634-a67e-22eced59274d"null,
    "organizationIntegrationIdcheckoutPageLink": "T1|D MG 01https://dev.thex.cloud/checkout/page?t=eyJkYXRhIjoiVTJGc2RHVmtYMS9Db0pEMVNJZjlPQ3pPRXFSNnpuUTNXYTI4cW4wSUhOQmF4cGFqMjBmYzhVNjlUVXJTRFN0JjUTJlalB2a2ZvYlk5Z1RYblVMTUc3QzlmWEZjNEwwQWRHSExGTHpCVmNQb21kQWqK042NHdJYWphdmhPektOMjRhTVlFcEE1YUJCU3gzbnVYdUNROHlMOUQ1WDdJeTlPZU03VHFmVncwVE92OUF4aHVGeDNVQ2svQW1FNmhpZmE0ZjFmNzc4V3o0NWtkR0Z4SGtvOGIzckowai9wSGpTVi91ZHFSTVhMZGZPeW1UL3cxeGtENmhXaG5Vcm9KaFNVRTQrbStJSk5nY0kyd2N6cjBYSVdVYWpjNS82QkJIUG1nMmJvbDM2aUJDbUVtdUdtdS9GSGpSbU5WRjZ2eDhCUW5MYkQvRXljK0RrWXZBbUNMNytRaW0zcHR0aS9aN3Z3cE1BMVZrbWtOdnVveGhNOUFqTHVhOWwwMEJqT1dXdmIyaTl2ZzVjMHEzcnRrY0hNTWNVUUZJYWluZVYvTW4zbjhYODdDRzNmdjdxNjU3SmJXbEE1bmVBMFovN3NIMWdtVlBZNWxUZVR3a01CWVp2MUJzNER1dVdUVzJiQ3YrTGl6bGpMdHZxOEhtUzBnT0lrdytkMkp4aHpkcm9TemxhdWtjSHJ5MUJHTUJHTDFkb1hxR3Q0TURPdDd4bllMbm9QN0hINWx3Z1hGaFk2TS9iRzNVcmswMld4TEptNWY2QXpXWFFUOXV4TEROMklyVG1JVWFid0x2eFUvQk01OFQ0dDlLSUhlWEpOR1N3NGRUQzhnK0JsVExxOXU0V3k1R3VEajI0QVVrYXRnWThBdEY3blhFQStpbWFwaWRxWGJmOG43T3RjNnVZeW5QTmJ1WW9VNytTaDlXeG1TSFFRWDRNMGovTkg2VDhjcDJOMXRBSlNpQVhkU3ZFM2R3cFVwbWR6c0ZUOTQ5YjhQQmROSTVqemU5SEpzU3ZPbFJ4eXNaNHpLU08zc3cwWVowK1BobW9HMHE4SkwyTEEzZzJGbmVGeDZ3dmNZWjhjNnZJOXY1eW5wNjJYeVhyVmMya0RYVVpkSlBLam1vZWIrTU5xaFoyRVZmVmphcmJ2c2ZSSjJpc2s3VmNvUGpwWFdpL09rMVVKTDk2SVJtZEJWRTlIMi94WVlDV0hsR1RNY3IyZVk1V2R5WGxzczRGOGtCUlByODlPM3c3blFkZjFWM1h6bVZVTzN3NFVMdTZ5YU1rUkNoOVcyVmZJNXlxd2lYNXlqbTVHSmgwK1FFTGFhS24xd1cwNkhMc080N0F4ODRkV0I1T3FlSDQ3SjhTN3crTm1ra2tEZm9xRjE1TFgyc21lZmhxY2FWaHJ6NVEvNVl0N3ZpN1IvcThBUmdZRHNjYmR6SElhOU5EU2g3cFRUU3hGeVpBSXdLU0NISTNDMjNuZ2k1Qk1aL0N1MmhRSm15NGlMRHhubzFtVi96aW0rSytrTGQvUDQ4TUtwVXZ2YWE1YzM1VzdsZ0h5cW5UckZsMjRhcEJDeU03UGtyaFhWTTFnMDl3Y2tJc2c4b0g1dTJlSTZWZ1FydURTZDRzWFI1UmpORXhoNm4wUEJsdWMwNlRFaG4zdTNFc2tnbHNxbk9DNTFMRzBGL0loY3RzMnJ5bnNCNWtEb21lQlJwOVd3ZkZkanFFMmR4c0NNYnNobTd6d3M5RTFYTzNaRVRDNENxWlJRS0pCd0kvMWlaZXRSWEZMT3N1ZmI1UDVGYlJsNjcrWnNONW9Jd3lvNUF4WUtneFNkWi9OcDBVQzZDMkJFZkZWbXFsUEVWTm5CdW5lWEE5OWxjclphbVcvQUJQVGJ2ekEzbm5vTG5HVktpVjd0bDVHMTA2TVNDbHI2NjlsWVk0bGZ0ZzZpOWFhdERoOFA3TVJ1cUJ1b21uVzIwTWcifQ==",
    "referencestatus": "00010020"2,
    "nameprovider": "TOTVs"1,
    "typeDocumentproviderDescription": "1 = NaturalPersonProvedor",
    "documentNumbermessage": "308540",
  "stateRegistration": "000.000.000.000Gerado link para a Tokenização",
    "cityRegistrationdateAdd": "000000-02022-09-27T19:15:29.303948",
    "statusisActive": "1 = Active",
  "birthDate": "01/01/2001",
  "isActive": true
}false
}

Acessar o link informado no campo checkoutPageLink, em seguida realize o preenchimento dos campos e clique em "Guardar Cartão"

Image Added

Com o Id do Customers e Id do Payment-Token armazenados, será possivel realizar a subscrição com o cartão tokenizado, segue procedimento para os campos que serão atualizados:

Maiores duvidas sobre a Subscrição, acesse.

POST api/v1/Subscriptions

customerId - informar o id customers;

"customerId": "429203e1-3261-45a7-b83c-9eb78deb9fca"

paymentTokenId - id Payment-Token;

"paymentTokenId": "e5ceab4d-f0d9-484b-a6cb-d3b8ee8ca639"

Aviso

title	Documentação

Para uma listagem completa da saída por favor verifique a documentação Swagger.

Card

label

Acesso a tela: API Subscrição com dados de pagamento.

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

Endpoint de homologação