Histórico da Página

É um recurso amplamente utilizado no e-commerce para agilizar o processo de compra, sem 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 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.

Card

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

Deck of Cards

id	Subscriptions

Card

label	Endpoint Payment-Token

Esse método permite guardar as informações do cartão para que seja 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.

Endpoint de homologação

https://api-recorrencia.staging.totvs.app/api/v1/rac/payment-token

Criando a tokenização.

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 payment-token

{
  "customerId": "3fa85f64429203e1-57173261-456245a7-b3fcb83c-2c963f66afa69eb78deb9fca" //Id gerado na criação do Customers
}

Parâmetros de SaídaSaída

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

Bloco de código

language	yml
title	RESPONSE Payment-Token

{
    "id": "341b5962e5ceab4d-2023f0d9-45c7484b-932fa6cb-ac836e34f477d3b8ee8ca639", //Id gerado pelo payment-token
    "status": "Received", //Status 
    "url": "/api/v1/payment-token/341b5962e5ceab4d-2023f0d9-45c7484b-932fa6cb-ac836e34f477d3b8ee8ca639", //Rota para inserir os dados do cartão. 
    "date": "2023-0209-10T1327T19:4115:5129.52394093039488+00:00" //Data de geração.
}

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:

Bloco de código

language	yml
title	GET Payment-Token

https://api-recorrencia.staging.totvs.app/api/v1/payment-tokenrac/payment-token/341b5962e5ceab4d-2023f0d9-45c7484b-932fa6cb-ac836e34f477d3b8ee8ca639

Parâmetros de Saída

Bloco de código

language	yml
title	RESPONSE Payment-Token

{
    "id": "341b5962e5ceab4d-2023f0d9-45c7484b-932fa6cb-ac836e34f477d3b8ee8ca639",
    "customerId": "021eb296429203e1-b80e3261-4c5e45a7-bdfbb83c-4131459b37049eb78deb9fca",
    "nickname": null,
    "lastFourDigits": null,
    "checkoutPageLink": "https://dev.thex.cloud/checkout/page?t=eyJkYXRhIjoiVTJGc2RHVmtYMS9Db0pEMVNJZjlPQ3pPRXFSNnpuUTNXYTI4cW4wSUhOQmF4cGFqMjBmYzhVNjlUVXJTRFN0JjUTJlalB2a2ZvYlk5Z1RYblVMTUc3QzlmWEZjNEwwQWRHSExGTHpCVmNQb21kQWqK042NHdJYWphdmhPektOMjRhTVlFcEE1YUJCU3gzbnVYdUNROHlMOUQ1WDdJeTlPZU03VHFmVncwVE92OUF4aHVGeDNVQ2svQW1FNmhpZmE0ZjFmNzc4V3o0NWtkR0Z4SGtvOGIzckowai9wSGpTVi91ZHFSTVhMZGZPeW1UL3cxeGtENmhXaG5Vcm9KaFNVRTQrbStJSk5nY0kyd2N6cjBYSVdVYWpjNS82QkJIUG1nMmJvbDM2aUJDbUVtdUdtdS9GSGpSbU5WRjZ2eDhCUW5MYkQvRXljK0RrWXZBbUNMNytRaW0zcHR0aS9aN3Z3cE1BMVZrbWtOdnVveGhNOUFqTHVhOWwwMEJqT1dXdmIyaTl2ZzVjMHEzcnRrY0hNTWNVUUZJYWluZVYvTW4zbjhYODdDRzNmdjdxNjU3SmJXbEE1bmVBMFovN3NIMWdtVlBZNWxUZVR3a01CWVp2MUJzNER1dVdUVzJiQ3YrTGl6bGpMdHZxOEhtUzBnT0lrdytkMkp4aHpkcm9TemxhdWtjSHJ5MUJHTUJHTDFkb1hxR3Q0TURPdDd4bllMbm9QN0hINWx3Z1hGaFk2TS9iRzNVcmswMld4TEptNWY2QXpXWFFUOXV4TEROMklyVG1JVWFid0x2eFUvQk01OFQ0dDlLSUhlWEpOR1N3NGRUQzhnK0JsVExxOXU0V3k1R3VEajI0QVVrYXRnWThBdEY3blhFQStpbWFwaWRxWGJmOG43T3RjNnVZeW5QTmJ1WW9VNytTaDlXeG1TSFFRWDRNMGovTkg2VDhjcDJOMXRBSlNpQVhkU3ZFM2R3cFVwbWR6c0ZUOTQ5YjhQQmROSTVqemU5SEpzU3ZPbFJ4eXNaNHpLU08zc3cwWVowK1BobW9HMHE4SkwyTEEzZzJGbmVGeDZ3dmNZWjhjNnZJOXY1eW5wNjJYeVhyVmMya0RYVVpkSlBLam1vZWIrTU5xaFoyRVZmVmphcmJ2c2ZSSjJpc2s3VmNvUGpwWFdpL09rMVVKTDk2SVJtZEJWRTlIMi94WVlDV0hsR1RNY3IyZVk1V2R5WGxzczRGOGtCUlByODlPM3c3blFkZjFWM1h6bVZVTzN3NFVMdTZ5YU1rUkNoOVcyVmZJNXlxd2lYNXlqbTVHSmgwK1FFTGFhS24xd1cwNkhMc080N0F4ODRkV0I1T3FlSDQ3SjhTN3crTm1ra2tEZm9xRjE1TFgyc21lZmhxY2FWaHJ6NVEvNVl0N3ZpN1IvcThBUmdZRHNjYmR6SElhOU5EU2g3cFRUU3hGeVpBSXdLU0NISTNDMjNuZ2k1Qk1aL0N1MmhRSm15NGlMRHhubzFtVi96aW0rSytrTGQvUDQ4TUtwVXZ2YWE1YzM1VzdsZ0h5cW5UckZsMjRhcEJDeU03UGtyaFhWTTFnMDl3Y2tJc2c4b0g1dTJlSTZWZ1FydURTZDRzWFI1UmpORXhoNm4wUEJsdWMwNlRFaG4zdTNFc2tnbHNxbk9DNTFMRzBGL0loY3RzMnJ5bnNCNWtEb21lQlJwOVd3ZkZkanFFMmR4c0NNYnNobTd6d3M5RTFYTzNaRVRDNENxWlJRS0pCd0kvMWlaZXRSWEZMT3N1ZmI1UDVGYlJsNjcrWnNONW9Jd3lvNUF4WUtneFNkWi9OcDBVQzZDMkJFZkZWbXFsUEVWTm5CdW5lWEE5OWxjclphbVcvQUJQVGJ2ekEzbm5vTG5HVktpVjd0bDVHMTA2TVNDbHI2NjlsWVk0bGZ0ZzZpOWFhdERoOFA3TVJ1cUJ1b21uVzIwTWcifQ=eyJkYXRhIjoiVTJGc2RHVmtYMStSZFlPeG05UE96b0JxZGFHeFpUUjNGS0ZSSkpZT3FyVC8rdkhrazlFMTQxcmE5azZWTFlRUGRETnVnWUZQOWVzaHRyMWdsRVAyd09rMTE5bUtwR2h2aVhpVFBselFPZERtK0dxUk1xa2pRWXJuak1tOHVMQ2VabWxVaGhPbkJmOVFZTFVrbTNvSjdjRXV5QUJDUFFGdyt4NmYzOTd6NWFMSm9OOXRybis0SVZnNjdRcWt2VjRENTl5MGJLTXJacnNFdnNjYThDTHhUVUJ0TzJuN1JBQVhkWERKdXNyc1lsN2E5b3ZNY2NGT2VlUVAveXhFeW1nUnErcEhTa0FVT2Joem8yb014VndhN3ArRXY2Zm9EYTVKaFJ6MitwWEJ1WVlIbGNjaGFpeWJ2bWJxcVVvZVEvMWNZNS9idVprRGl3aUU5OSsweXFOcGxwdE0xRjlSdkZmbEljeVFjc3BuNWEwbjNINERmbXlmaVVVcHRwZGR6V2hkVk0wRFE2Rk92a01MTDRBUTNmREVZT0xGc1p3d01aeUhzdHBUdWx5R2lWdFBGY1Y1RTRMV2NvK3lVb1ZObzc5bVg1TFQzZzJOT1MyRHhVcGVieU5zTnJqb1lvR0M0VVg0K2I4b0dUYVRsNUhnOThGeXBMeXYrVVYrU0xZS1MxRjQ1bmhiQ3VmTXM4Q0tLdDRzS3BNLzFpQVp3dEVMcEFDK3BwV204WFZFaVZVeHY0WXBOM2FIV2xvc05qOFo2N2JzVm9qcHhHWlBPOFl2MEVuL1NNbDdHRkxpMS9ad3lxL1BlZ2dKWlJqVkR5NlEzUTd0eGhFQ0gvYms1aUZCSlVkdlU2Y0M5MHZPcnBxc2VFb3FZcHlPTVY2ZE9tWGNFbnVScXRHRCs3SUxuaWdmSU9ES2FXYUIwRVFJVThka1dhUHpXMU1Kb2dEVHp4VzgvSUpWY0pFNVlxTDBMZHY5QTRKeWV5elJZYmdUNTZaK3lweHE0V1owaVBwdVFxS3BDQUl4ZzExYWpSSVBNSTFpMzZjSnJicnJJaWR6Zk0raXUrbGsrNS9QK29hVGdjWnZmU1RJb3cwOFpkeERkcWVvQmlUazUvZTBUeXJJck1JbkV6R3hlWGpVR1pITElEZE8ySzM0T0lMaTI1ZVQ1MlNvWm1TMkRRQThSN1pqb1NRdVFnQXUyMjNrcjVubTFMYVFudFA4dk1vUlNvanF1R0RscDlXN1dLV2RKVnk3SHE3YlUrbG9qMFVEQnVIb0hoUWNtSXQwbnZNUmRaVVY0Z1M3d2pXaDRBMGlSOUZRdFNxOWMzaUFMNk5NSE9mbWpUaG9WcEd3bm9kODQxWDFqZXBCWHNNTXJ4QVlJcEdncXVZUjJtZkpwKzBia1BVNkRTNy9QZkZCbWczWGtqQTJSeFNFS3Y2NXFLcis3cG1BZVg0Q2RSUk1KZTNTb2ltdXcvaDBBM3dJM216aEJuT0xzVEhwUHd4cTdNMjBFRzhSMjBhZERmWlphREtMckJHbURxMDhWZlRjanh4ZGpGbHo0NUpFU2dSbjVBYUYrVVNIQnlxTGYrZEFTOENDVEpOdFpFYUJ1NUoxeXN4VVloL0ZsQ2s5akx3V0ZNbHJZajM2cGFBcjBPMGtyZzVpNUxDY2h6RStTeEhjVTArNGwzR2VyUHVCc2pjMDRydm56dVFReTJZcmVVRkQzSzJBWElnZitlL1JIckQ3c2VnVG8vYlA4NDhxV0sydC9EblVSc1BVcW1XV0NaNUE5N3NpT1JkSEtZR1FmWHlmZWpIRnNtY3JqTGMvSzI0eXBrNDJZZz09In0=",
    "status": 2,
    "provider": 1,
    "acquirerproviderDescription": 2"Provedor",
    "message": "Gerado link para a Tokenização",
    "dateAdd": "20232022-0209-10T1327T19:4115:5129.52394303948",
    "isActive": false
}

Aviso

title	Armazenamento do ID

Armazene o Id, pois será utilizado no momento da realização da subscrição.
Nesse exemplo: "id": "341b5962-2023-45c7-932f-ac836e34f477"

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

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.

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

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

Endpoint de homologação