Pular para o conteúdo principal

Lista tipos de pagamento

GET 

/type/order/payment

Retorna os tipos de pagamento ativos da empresa, ordenados por descrição. Cada item traz a categoria (cartão de crédito, débito, Pix, boleto, dinheiro, vale, etc.), o código do meio de pagamento da NF-e NfTPag herdado da categoria e a bandeira NfTBand quando o tipo tem uma — o cadastro pelo produto exige bandeira nas categorias 1 (cartão de crédito) e 6 (cartão de débito), mas a API não impede que um tipo dessas categorias venha sem bandeira. Tipos de pagamento cuja categoria não corresponde a nenhuma categoria cadastrada não aparecem na lista. Quando OrderReturn=1, a lista é montada para a escolha da forma de estorno numa devolução no PDV: entram apenas tipos habilitados para frente de caixa cujo meio de pagamento da NF-e seja dinheiro, cheque, depósito bancário, Pix ou outros, cada item ganha RefundMethod igual a TYPE_PAYMENT e a lista começa com uma opção sintética Pagamento Original.

Request

Responses

Lista de tipos de pagamento ativos. Com OrderReturn=1 a lista começa com um item sintético que não é um tipo de pagamento cadastrado — ele traz apenas IDTypePayment com o valor literal ORIGINAL, TypePaymentDescription Pagamento Original, RefundMethod ORIGINAL e EnableFrenteCaixa 1; todos os demais campos vêm ausentes e, só nesse item, IDTypePayment deixa de ser um número em formato string.