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;
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

{ "id": "9495d9da-33be-4634-a67e-22eced59274d", "integrationId": "T1|D MG 01|0021878", "code": "123456", "organizationId": "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 }

Card

label	CustomerPayment-Token

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

Endpoint de homologação

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

Parâmetros de Entrada

Bloco de código

language	yml
title	POST Customerspayment-token

{
  "codecustomerId": "123456",3fa85f64-5717-4562-b3fc-2c963f66afa6" //Identificador do cliente
  "reference": "00010020", //Id códigogerado externo
  "name": "TOTVs", //Nome do cliente
  "typeDocument": "1 = NaturalPerson", //Tipo de documento 1=NaturalPerson;2=LegalPerson
  "documentNumber": "308540", //Número do documento
  "status": "1 = Active",
  "addresses": [
    na criação do Customers
}

Parâmetros de Saída

Bloco de código

language	yml
title	RESPONSE Payment-Token

{
      "typeid": "1 = Home341b5962-2023-45c7-932f-ac836e34f477", //TipoId degerado endereço 1=Home;2=Business;3=Billing  
  pelo payment-token
    "streetstatus": "Rua Dom Pedro IReceived", //Endereço
      "number": "100", //Número
  Status 
    "complementurl": "Bloco B", // Complemento
      "district": "Bairro Jardim", //Bairro
      "zipCode": "00000-000api/v1/payment-token/341b5962-2023-45c7-932f-ac836e34f477", //CEP
Rota para inserir os dados  "cityName": "São Paulo", //Cidadedo cartão. 
      "stateInitialsdate": "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
}2023-02-10T13:41:51.5239409+00:00" //Data de geração.
}

Parâmetros de Entrada

Bloco de código

language	yml
title	GET Payment-Token

https://api-recorrencia.staging.totvs.app/api/v1/payment-token/payment-token/341b5962-2023-45c7-932f-ac836e34f477

Parâmetros de Saída

Bloco de código

language	yml
title	POST CustomersRESPONSE Payment-Token

{
    "id": "9495d9da341b5962-33be2023-463445c7-a67e932f-22eced59274dac836e34f477",
  "integrationId": "T1|D MG 01|0021878",
  "codecustomerId": "123456",
  "organizationId": "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
}

Parâmetros de Entrada

Bloco de código

language	yml
title	GET Customers

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

Parâmetros de Saída

Bloco de código

language	yml
title	GET Customers

021eb296-b80e-4c5e-bdfb-4131459b3704",
    "nickname": null,
    "lastFourDigits": null,
    "checkoutPageLink": "https://dev.thex.cloud/checkout/page?t=eyJkYXRhIjoiVTJGc2RHVmtYMStSZFlPeG05UE96b0JxZGFHeFpUUjNGS0ZSSkpZT3FyVC8rdkhrazlFMTQxcmE5azZWTFlRUGRETnVnWUZQOWVzaHRyMWdsRVAyd09rMTE5bUtwR2h2aVhpVFBselFPZERtK0dxUk1xa2pRWXJuak1tOHVMQ2VabWxVaGhPbkJmOVFZTFVrbTNvSjdjRXV5QUJDUFFGdyt4NmYzOTd6NWFMSm9OOXRybis0SVZnNjdRcWt2VjRENTl5MGJLTXJacnNFdnNjYThDTHhUVUJ0TzJuN1JBQVhkWERKdXNyc1lsN2E5b3ZNY2NGT2VlUVAveXhFeW1nUnErcEhTa0FVT2Joem8yb014VndhN3ArRXY2Zm9EYTVKaFJ6MitwWEJ1WVlIbGNjaGFpeWJ2bWJxcVVvZVEvMWNZNS9idVprRGl3aUU5OSsweXFOcGxwdE0xRjlSdkZmbEljeVFjc3BuNWEwbjNINERmbXlmaVVVcHRwZGR6V2hkVk0wRFE2Rk92a01MTDRBUTNmREVZT0xGc1p3d01aeUhzdHBUdWx5R2lWdFBGY1Y1RTRMV2NvK3lVb1ZObzc5bVg1TFQzZzJOT1MyRHhVcGVieU5zTnJqb1lvR0M0VVg0K2I4b0dUYVRsNUhnOThGeXBMeXYrVVYrU0xZS1MxRjQ1bmhiQ3VmTXM4Q0tLdDRzS3BNLzFpQVp3dEVMcEFDK3BwV204WFZFaVZVeHY0WXBOM2FIV2xvc05qOFo2N2JzVm9qcHhHWlBPOFl2MEVuL1NNbDdHRkxpMS9ad3lxL1BlZ2dKWlJqVkR5NlEzUTd0eGhFQ0gvYms1aUZCSlVkdlU2Y0M5MHZPcnBxc2VFb3FZcHlPTVY2ZE9tWGNFbnVScXRHRCs3SUxuaWdmSU9ES2FXYUIwRVFJVThka1dhUHpXMU1Kb2dEVHp4VzgvSUpWY0pFNVlxTDBMZHY5QTRKeWV5elJZYmdUNTZaK3lweHE0V1owaVBwdVFxS3BDQUl4ZzExYWpSSVBNSTFpMzZjSnJicnJJaWR6Zk0raXUrbGsrNS9QK29hVGdjWnZmU1RJb3cwOFpkeERkcWVvQmlUazUvZTBUeXJJck1JbkV6R3hlWGpVR1pITElEZE8ySzM0T0lMaTI1ZVQ1MlNvWm1TMkRRQThSN1pqb1NRdVFnQXUyMjNrcjVubTFMYVFudFA4dk1vUlNvanF1R0RscDlXN1dLV2RKVnk3SHE3YlUrbG9qMFVEQnVIb0hoUWNtSXQwbnZNUmRaVVY0Z1M3d2pXaDRBMGlSOUZRdFNxOWMzaUFMNk5NSE9mbWpUaG9WcEd3bm9kODQxWDFqZXBCWHNNTXJ4QVlJcEdncXVZUjJtZkpwKzBia1BVNkRTNy9QZkZCbWczWGtqQTJSeFNFS3Y2NXFLcis3cG1BZVg0Q2RSUk1KZTNTb2ltdXcvaDBBM3dJM216aEJuT0xzVEhwUHd4cTdNMjBFRzhSMjBhZERmWlphREtMckJHbURxMDhWZlRjanh4ZGpGbHo0NUpFU2dSbjVBYUYrVVNIQnlxTGYrZEFTOENDVEpOdFpFYUJ1NUoxeXN4VVloL0ZsQ2s5akx3V0ZNbHJZajM2cGFBcjBPMGtyZzVpNUxDY2h6RStTeEhjVTArNGwzR2VyUHVCc2pjMDRydm56dVFReTJZcmVVRkQzSzJBWElnZitlL1JIckQ3c2VnVG8vYlA4NDhxV0sydC9EblVSc1BVcW1XV0NaNUE5N3NpT1JkSEtZR1FmWHlmZWpIRnNtY3JqTGMvSzI0eXBrNDJZZz09In0=",
    "status": 2,
    "acquirer": 2,
    "message": "Gerado link para a Tokenização",
    "dateAdd": "2023-02-10T13:41:51.52394",
    "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"

Image Added

Aviso

title	Documentação

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

Card

label	Subscrição com dados de pagamento

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave

Endpoint de homologação