Cadastrar Provisioned User
Atualizar Provisioned User
Permite o cadastro de usuários de forma simplificada facilitando a captura de dados de usuários.
Disponibilizando interfaces de entrada mais simplificadas com campos não obrigatórios, esta API fornece um conjunto de mutations graphQL para o cadastro rápido das informações de um usuário ou portador de cartão.
A captura desses dados pode auxiliar a área de negócios trazendo mais insumos para as tomadas de decisões estratégicas visando sempre a melhor experiência dos usuários dentro do ecossistema de APIs da Elo.
Para criação de um usuário provisório deve-se utilizar a mutation createProvisionedUser. Forneça o maior número de informações do usuário possível e para especificar a origem do cadastro utilize o campo origin. A mutation abaixo mostra a criação de um provisioned user.
createProvisionedUser(
cpf: "123456789",
number: "0978654322",
issueDate: "2018-04-24"
birthday: "1993-08-09",
maritalStatus: SINGLE,
personal: 1000.01,
family: 1000.01,
type: PHONE,
value: "+5527999365103"
stateAbbrev: "SP",
zip: "2343434",
district: "district",
kind: "AV.",
place: "Sao Jose dos baurus",
complement: "complement",
reference: "reference",
instructions: "Instructuions",
lon: 1232,
lat: 12121
origin: "Campanha USE Elo"
Para alterar os dados de um usuário já existente dentro do ecossistema de APIs, é possível utilizar a mutation updateProvisionedUser informando apenas os campos que devem ser alterados.
updateProvisionedUser(
clientMutationId: "232",
id: "5d83bdde-99bd-4ab7-bc5c-a1e5f8f8c244",
number: "0987654321",
zip: "12312312",
place: "place"
status { status }
cards { id }
A API oferece a opção da criação de um cartão para um usuário provisório. Para criar um cartão é necessário utilizar a função createProvisionedCard. Esta mutation é responsável por criar um novo cartão associado ao usuário. Para poder fazer uso dessa função o usuário provisório deve estar criado e ter cadastrado uma chave pública.
Para cadastrar uma chave pública use a mutation addPublicKeyToProvisionedUser.
addPublicKeyToProvisionedUser(
userId: "5d83bdde-99bd-4ab7-bc5c-a1e5f8f8c244",
key: "{\"kty\":\"EC\", \"kid\":\"my-public-key-id-1\", \"x\":\"g_Sr4WwVDt5Qy3KonZyXqFwWykTR9KVMCt8Sx-dXSB8\",\"y\":\"ydSE-mUMtuhBTI_txDpd2ivb7e6FNzxq4e_18iHFZ2U\",\"crv\":\"P-256\"}",
format: JWK
income {
Para criar um cartão é necessário primeiro obter os dados sensíveis.O campo sensitive é o conteúdo sensível (Número do cartão, Nome do portador, Vencimento, etc) gerado a partir de um processo de assinatura e criptografia, cujo payload foi assinado a partir do uso de uma a chave privada do usuário e na sequência criptografado fazendo uso de uma chave pública do servidor. Saiba como obter o sensitive.
Após obtido os dados sensíveis do cartão, é necessário utilizar a mutation createProvisionedCard. Essa mutation cria um cartão para o usuário em questão.
createProvisionedCard(
clientMutationId: "1232",
sensitive: "eyJhbGciOiJFQ0RILUVTIiwiZW5jIjoiQTEyOENCQy1IUzI1NiIsImVwayI6eyJ",
bin: "655500",
last4: "6378"
expiry {
Para consultar os dados de um usuário provisório basta utilizar a query informando os dados desejados como mostra o exemplo abaixo:
provisionedUsers(filter: {name: "name", legalId: {cpf: ""}, bin: "", last4: ""}) {
provisionedUsers
Query (consulta) de usuários provisorio.
filter: ProvisionedUserFilterInput
createProvisionedCard
Cadastra um Cartão para um Usuário Provisorio.
O cadastro de um cartão deve ser feito pelo Usuário Provisorio, Merchant ou pelo emissor do cartão, sendo verificado:
input: CreateProvisionedCardInput obrigatório
addPublicKeyToProvisionedUser
Adiciona uma chave pública a um usuário provisorio
createProvisionedUser
Cria um ProvisionedUser de Usuário
input: CreateProvisionedUserInput obrigatório
updateProvisionedUser
Altera os dados de um ProvisionedUser de Usuário
input: UpdateProvisionedUserInput obrigatório
ProvisionedUserFilterInput
Entrada para filtragens de busca por usuários provisorio
Procura o usuário provisorio pelo seu name
Procura o usuário provisorio pelo seu documento
O tamanho do número em caracteres define o tamanho do prefixo utilizado. No passado os BINs eram de apenas 4, hoje são de 6 dígitos, porém o mercado está migrando para até 9 dígitos nos próximos anos. Logo utilize a quantidade de dígitos parametrizada no seu código! Veja também panSizeRange, afinal quando o tamanho do prefixo muda, em geral muda-se também o tamanho total do cartão.
Últimos 4 dígitos do cartão, para ser mostrado ao usuário Pode ser nulo dependendo de permissões e acesso.
Procura o usuário provisorio pela origem Se null ou vazio, não realiza filtragem.
Procura o usuário provisorio pelo analyticsId Se null ou vazio, não realiza filtragem.
CreateProvisionedCardInput
Entrada para mutação createProvisionedCard().
Identificador global único referente ao usuário.
Hash número do cartão utilizando algoritmo SHA256.
Entrada para informações da transação
CreateProvisionedUserInput
Entrada para mutação createProvisionedUser().
Identificador de ProvisionedUser opaco, normalmente em formato UUIDv4.
list de AddressInput
Identifica o evento do cadastro do usuário.
Identifica o ticket do cadastro do usuário.
UpdateProvisionedUserInput
Entrada para mutação UpdateProvisionedUser().
ProvisionedUsersEdge
Aresta de conexão contendo um ProvisionedUsers em conformidade com o Relay.
ProvisionedUser
O objeto User que compõe esta aresta de conexão.
ProvisionedUsersConnection
Conexão de ProvisionedUsers em conformidade com o Relay.
list de ProvisionedUsersEdge
list de Merchant obrigatório
CreateProvisionedUserPayload
Retorno da mutação CreateProvisionedUser().
Identificador Global Único para este Lead
Usuário Provisorio do Sistema Disponivel para receber dados parciais do cadastro de User
list de PersonContact
list de Address
list de Card
list de CardToken
O token criado, seu PAN e CSC (Código de Segurança) são retornados usando seu membro sensitive.
Identifica se o usuário foi migrado para base de cadastro de Portador.
Token de Cartão: identificador opaco que substitui o cartão real e suas informações sigilosas.
Tokens podem ser criados pelo portador do cartão utilizando uma carteira digital, ou um comerciante que o utiliza ao invés de um cartão, para reduzir as informações sigilosas armazenadas em seus servidores.
Tokens (CardToken) implementam a mesma interface que o cartão (Card), (CardInterface) e pode ser usado como tal em outras chamadas, porém possui membros extras, como origin, que declara como, quando e porque foi criado.
O cartão real a que se refere o token.
Atenção: estas queries em dados sigilosos do cartão, normalmente retornarão null a não ser que permissões autorizem seu acesso.