Pagamentos
Operações · PagamentosConsultar pagamento
Consulta ordens de pagamento pelo identificador da API ou pelo identificador do ERP.
POSThttps://api.smarttef.mobi/pooling/order/get
Authorization
AuthorizationBearer <token>in: header
Token JWT no formato: Bearer {token}
ocp-apim-subscription-key<token>in: header
Gateway Token recebido na criacao da loja.
Request Body
Informe payment_identifier ou charge_id.
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
Identificador do pagamento devolvido na criação. Precisa ser um UUID válido.
Formato:UUIDExemplo:68ab8366-29db-438e-9a39-8ca72691c0b7
Identificador do card no ERP.
Padrão:vazioquando você não enviaExemplo:966
Response Body
payment_identifierstringIdentificador único do pagamento, gerado pela API.
cnpjstringCNPJ da loja dona do pagamento.
create_atstringData de criação, já convertida para o fuso de São Paulo.
update_atstringData da última atualização, já convertida para o fuso de São Paulo.
valuenumber | nullValor solicitado no pagamento.
payment_valuenumber | nullValor efetivamente pago no terminal. Fica nulo até a conclusão.
payment_datestring | nullData em que o pagamento foi concluído.
autorization_codestring | nullCódigo de autorização devolvido pela adquirente.
order_typestringDirecionamento do card.
NRM deixa o card na lista geral, CRD_UNICO abre direto no destino e GROUPED identifica cards agrupados pelo POS.payment_typestring | nullTipo de pagamento efetivamente usado no terminal.
payment_statusstring
card_brandstring | nullBandeira do cartão utilizado.
installmentsnumber | nullQuantidade de parcelas solicitada.
min_installmentsnumber | nullQuantidade mínima de parcelas permitida.
nsu_hoststring | nullNSU atribuído pelo host da adquirente.
nsu_sitefstring | nullNSU atribuído pelo SiTef.
acquirerstring | nullNome da adquirente que processou a transação.
serial_posstring | nullSerial do POS que processou o card.
user_idnumber | nullIdentificador do operador que processou o card.
payment_extrasobject | nullDados extras devolvidos pela adquirente no processamento.
extrasobject | nullCampos extras enviados pelo ERP na criação.
has_detailsboolean | nullIndica se
extras pode ser exibido na tela de detalhes do app.typestringTipo do card. Sempre
PAYMENT nesta coleção.charge_idstring | nullIdentificador do card definido pelo ERP.
controle_versaostring | nullVersão do app Smart TEF instalada no terminal que atendeu o card.
conn_typestring | nullTipo de conexão do terminal no momento da atualização.
batt_levelstring | nullPercentual de bateria do terminal.
chargingboolean | nullIndica se o terminal estava no carregador.
locationobject | nullLocalização informada pelo terminal na última atualização do card.
reasonobject | nullMotivo da rejeição informado pelo POS, quando houver.
refund_autorization_codestring | nullCódigo de autorização do estorno.
refund_serial_posstring | nullSerial do POS que realizou o estorno.
refund_user_idstring | nullIdentificador do operador que realizou o estorno.
couponobject | nullComprovantes do pagamento.
refound_couponobject | nullComprovantes do estorno.
fee_typestring | nullResponsável pelos juros no crédito parcelado.
refund_datestring | nullData do estorno.
acquirer_cnpjstring | nullCNPJ da adquirente. Em transações Clover é extraído de
payment_extras.remaining_payment_amountnumber | nullSaldo em aberto do card, calculado como
value menos payment_value.partial_paymentsobject[]Pagamentos parciais que compõem um card multi pagamento. Lista vazia quando não houver.
grouped_paymentsobject[]Cards originais que foram agrupados neste pagamento. Lista vazia quando não houver.
form_orderobject[]Formulário vinculado ao pagamento. Nulo quando o card não tem formulário.