Valor da cobrança, com separador decimal e no máximo duas casas.
Mínimo:1(sem máximo)Exemplo:19.9
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
Tipo de pagamento que o terminal deve aplicar.
Padrão:OTHERSquando você não enviaAceita:CREDITDEBITPIXVOUCHEROTHERSExemplo:DEBIT
Quantidade de parcelas. Só pode passar de 1 quando payment_type for CREDIT.
Mínimo:1(sem máximo)Padrão:1quando você não enviaExemplo:6
Quantidade mínima de parcelas aceita. Não pode ser maior que installments.
Mínimo:1(sem máximo)Padrão:1quando você não enviaExemplo:2
Responsável pelos juros no crédito parcelado. Preenchido com F_STORE quando o crédito é parcelado e o campo não é enviado.
Aceita:F_STOREF_CLIENTNONEvazioExemplo:F_CLIENT
Identificador do card no ERP. Precisa ser único entre os pagamentos em aberto da loja.
Padrão:vazioquando você não enviaExemplo:966
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 card. Não pode ser combinado com user_id.
Padrão:vazioquando você não enviaExemplo:1490063579
Operador que receberá o card. Não pode ser combinado com serial_pos.
Padrão:0quando você não envia
Campos extras do ERP, como CPF, CNPJ e Nome.
Chaves:livres(as chaves abaixo são um exemplo)
Exemplo:000.000.000-00
Exemplo:Teste da Silva
Permite quitar o card em pagamentos parciais no terminal.
Padrão:falsequando você não envia
Permite dar baixa no card em dinheiro.
Padrão:falsequando você não envia
Formulário a ser coletado junto do pagamento.
Campos que o operador deve preencher.
Itens:1no mínimo
Nome do campo exibido ao operador.
Exemplo:Email
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
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. Deve ser único entre formulários pendentes ou em processamento 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)
Permite abrir a tela de detalhes do card.
Padrão:falsequando você não envia
Response Body
application/json
payment_identifierstringIdentificador único do pagamento, gerado pela API. Guarde-o para consultas, cancelamento e estorno.
payment_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.
charge_idstringIdentificador do card informado pelo ERP.
allow_multi_paymentsbooleanIndica se o card aceita ser quitado em pagamentos parciais.
allow_cash_paymentbooleanIndica se o card aceita baixa em dinheiro no terminal.
has_detailsbooleanSempre verdadeiro.
formobject | nullFormulário vinculado ao pagamento. Nulo quando form não é enviado.
