Baixa de documento

O objetivo desta serviço é executar a baixa de um documento financeiro por motivo de Pagamento. Abaixo, segue exemplo do json de envio:

Pagamento com dinheiro:

{
  "document_payment":
  {
    "payment_type": "money",
    "document_id": 22563, 
    "document_historic_id": 65874, 
    "payment_account_id": 1,
    "payment_historic_id": 20,
    "payment_date": "2019-07-18",
    "payment_credit_date": "2019-07-18",
    "payment_discount_type": "V",
    "payment_discount_amount": 10.5,
    "payment_interest_type": "P",
    "payment_interest_amount": 0,
    "payment_fine_type": "P",
    "payment_fine_amount": 0,
    "rate_amount": 1.25,
    "rate_historic_id": 13,
    "rate_currency_id": 1,
    "payment_comment": "baixa avulsa",
    "unblock_customer": true
  }
}

Pagamento com cartão de crédito (máquina) em 3 parcelas:

{
  "document_payment":
  {
    "payment_type": "credit_card_machine",
    "document_id": 22563, 
    "document_historic_id": 65874,
    "payment_date": "2019-07-18",
    "payment_discount_type": "V",
    "payment_discount_amount": 10.5,
    "payment_interest_type": "P",
    "payment_interest_amount": 0,
    "payment_fine_type": "P",
    "payment_fine_amount": 0,
    "payment_comment": "baixa com cartão de crédito",
    "unblock_customer": true,
    "payment_installments": 3,
    "card_brand": "visa",
    "payment_receipt":
    {
      "document_number": 123456,
      "authorization_number": "ABCDE123"
    }
  }
}

Pagamento com cartão de débito (máquina):

{
  "document_payment":
  {
    "payment_type": "debit_card_machine",
    "document_id": 22563, 
    "document_historic_id": 65874,
    "payment_date": "2019-07-18",
    "payment_discount_type": "V",
    "payment_discount_amount": 10.5,
    "payment_interest_type": "P",
    "payment_interest_amount": 0,
    "payment_fine_type": "P",
    "payment_fine_amount": 0,
    "payment_comment": "baixa com cartão de débito",
    "unblock_customer": true,
    "card_brand": "master",
    "payment_receipt":
    {
      "document_number": 123456,
      "authorization_number": "ABCDE123"
    }
  }
}

Detalhamento dos campos

ID	Campo	Obrigatório	Pai	Tipo	Observações
A01	Dados da autenticação	Sim	Raiz	-
A02	document_id	Sim	A01	Número	Código interno do documento no sistema (sequência).
A03	document_historic_id	Sim	A01	Número	Número do histórico de baixa.
A04	payment_account_id	Sim*	A01	Número	Número da conta corrente da contrapartida do pagamento. Este campo não deve ser informado para os tipos de pagamento "credit_card_machine" e "debit_card_machine".
A05	payment_historic_id	Sim*	A01	Número	Número do histórico da contrapartida do pagamento. Este campo não deve ser informado para os tipos de pagamento "credit_card_machine" e "debit_card_machine".
A06	payment_date	Sim	A01	Data	Data de baixa no formato AAAA-MM-DD.
A07	payment_credit_date	Não	A01	Data	Data do crédito em conta no formato AAAA-MM-DD. Caso seja igual à data de baixa, informar conteúdo nulo. Este campo não deve ser informado para os tipos de pagamento "credit_card_machine" e "debit_card_machine".
A08	payment_discount_type	Sim	A01	Lista	Tipo de desconto a ser concedido na baixa. Valores possíveis: P: desconto em percentual V: desconto em valor
A09	payment_discount_amount	Não	A01	Decimal (15.2)	Valor ou percentual do desconto conforme parametrizado no campo A08.
A10	payment_interest_type	Sim	A01	Lista	Tipo de juros a ser concedido na baixa. Valores possíveis: P: juros em percentual V: juros em valor
A11	payment_interest_amount	Não	A01	Decimal (15.2)	Valor ou percentual dos juros conforme parametrizado no campo A10.
A12	payment_fine_type	Sim	A01	Lista	Tipo de multa a ser concedida na baixa. Valores possíveis: P: multa em percentual V: multa em valor
A13	payment_fine_amount	Não	A01	Decimal (15.2)	Valor ou percentual dos juros conforme parametrizado no campo A12.
A14	rate_amount	Não	A01	Decimal (15.2)	Valor da tarifa cobrada na baixa.
A15	rate_historic_id	Não	A01	Número	Número do histórico de tarifas. Este campo sempre deverá ser informado quando o campo A14 for informado.
A16	rate_currency_id	Não	A01	Número	Código da moeda para contabilização da tarifa. Este campo sempre deverá ser informado quando o campo A14 for informado.
A17	payment_comment	Não	A01	Texto	Texto livre para complemento da baixa.
A18	unblock_customer	Sim	A01	Booleano	Campo para indicar se o cliente deverá ser desbloqueado na baixa (caso o documento que esteja sendo baixado tenha sido o responsável pelo bloqueio do cliente). true: desbloquear o cliente false: não desbloquear o cliente
A19	payment_type	Não	A01	Lista	Tipo de pagamento. Valores permitidos: money: é o tipo de pagamento padrão. Deve ser utilizado para pagamento em espécie. credit_card_machine: pagamento com cartão de crédito via máquina (não on-line). debit_card_machine: pagamento com cartão de débito via máquina (não on-line). Quando não informado, este campo assume o valor "money". Para os tipos "credit_card_machine" e "debit_card_machine" é necessário existir um convênio de cartão ativo cadastrado no sistema.
A20	payment_installments	Não*	A01	Número	Neste campo deve ser informada a quantidade de parcelas para pagamentos com cartão de crédito (payment type = credit_card_machine). São aceitos valores inteiros positivos maiores do que zero. Para pagamentos do tipo "money", este campo não precisa ser informado. Para pagamentos do tipo "debit_card_machine", este campo não precisa ser informado. Se for informado, o seu valor deve ser igual a 1.
A21	card_brand	Não*	A01	Lista	Bandeira do cartão utilizada para pagamento dos tipos "credit_card_machine" e "debit_card_machine". Bandeiras aceitas atualmente: amex aura diners discover elo hipercard jcb master visa É necessário que a bandeira esteja cadastrada no convênio de cartão para que a mesma seja permitida.
A22	payment_receipt	Não	A01	-	Campo que contém campos para indicar informações do recibo de pagamento gerado nos pagamentos dos tipos "credit_card_machine" e "debit_card_machine".
B01	document_number	Não	A22	Número	Número do documento do recibo. Aceita valores inteiros positivos.
B02	authorization_number	Não	A22	Texto	Código de autorização do recibo.

 

Mensagem de retorno

Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result":
  {
     "receipt_id": 145887
  }
}

Em caso de falha, será retornado um json conforme o exemplo abaixo:

{
  "status": 0,
  "error_code": 12,
  "error_description": "Internal Server Error!",
  "result": ""
}