Histórico da Página

Card

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

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.

Deck of Cards

id	Subscriptions

Card

label	Customer

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

Endpoint de homologação

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

Parâmetros de Entrada

Bloco de código

language	yml
title	POST Customers

{
  "code": "123456", //Identificador do cliente
  "reference": "00010020", //Id código 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": [
    {
      "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

Bloco de código

language	yml
title	POST Customers

{
  "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
}

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

{
  "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
}

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 1

Nova versão 2

Chave

Endpoint de homologação