Valor inicial do campo. É o POS que devolve o valor preenchido.
Padrão:vazioquando você não envia
Máscara e teclado aplicados ao campo.
Padrão:TEXTOquando você não enviaAceita:TEXTONUMBERDATACPFCNPJCEPEMAILExemplo:EMAIL
Torna o preenchimento obrigatório. Basta um campo obrigatório para o formulário inteiro virar REQUEST_MANDATORY_FORM.
Padrão:falsequando você não enviaExemplo:true
CNPJ da loja, somente dígitos. Quando omitido, a API usa o CNPJ do token. Quando enviado, precisa ser igual ao CNPJ do token, caso contrário a requisição é recusada com CNPJ inválido.
Tamanho:14 dígitosexatos, sem pontuação
Direcionamento do card. NRM deixa o card na lista geral, CRD_UNICO abre direto no destino e GROUPED identifica cards agrupados pelo POS.
Padrão:NRMquando você não enviaAceita:CRD_UNICONRMGROUPEDExemplo:NRM
Serial do POS que receberá o formulário. Não pode ser combinado com user_id.
Padrão:vazioquando você não envia
Operador que receberá o formulário. Não pode ser combinado com serial_pos.
Padrão:0quando você não envia
Nome de referência do formulário. Precisa ser único entre os formulários em aberto da loja.
Exemplo:cadastro-cliente
Forçado para REQUEST_MANDATORY_FORM quando algum campo tiver needed verdadeiro.
Padrão:REQUEST_COMUM_FORMquando você não enviaAceita:REQUEST_COMUM_FORMREQUEST_MANDATORY_FORM
Dados complementares do ERP.
Chaves:livres(as chaves abaixo são um exemplo)
Exemplo:12612554000131
Permite abrir a tela de detalhes do card.
Padrão:falsequando você não envia
Reservado. O formulário sempre nasce pendente.
Padrão:PDTquando você não enviaAceita:PDT
Reservado. Formulários criados por esta rota são independentes. O valor PAYMENT é aplicado pela própria API quando o formulário vai dentro de um pagamento.
Padrão:NONEquando você não enviaAceita:NONE
Response Body
application/json
form_identifierstringIdentificador único do formulário, gerado pela API.
form_statusstring
order_typestringDirecionamento do card. NRM deixa o card na lista geral, CRD_UNICO abre direto no destino e GROUPED identifica cards agrupados pelo POS.
form_urlstringURL do JSON do formulário armazenado no blob storage.
form_namestring | nullNome de referência informado na criação.
