Comando executar pagamento

OBJETIVO

Esse comando tem como objetivo solicitar um pagamento avulso para o PDV. Esse comando só poder ser solicitado apenas no evento Menu venda fechada.

CAMPOS

Exemplo utilizando o simulador da Custom API.

• Operação - Operação do pagamento

Tipo = Enum

Permite nulo = Não

Valores permitidos:

optPayment - Valor para solicitar um pagamento;  

optReversal - Valor para solicitar um estorno;

• ID pagamento - Id da transação de pagamento, campo usado apenas no estorno, deve ser informado o ID pagamento retornado na operação de pagamento

Tipo = String

Permite nulo = Sim, precisa ser informado apenas na solicitação de estorno

• Espécie pagamento - Espécie de pagamento para ser exibida no PDV

Tipo = Array de enum

Permite nulo = Sim, quando for nulo será exibido todas as espécie de pagamento no PDV.

Valores permitidos:

cptMoney - Espécie dinheiro;

cptDebitCard - Espécie cartão de débito;

cptCreditCard - Espécie cartão de crédito;

cptBillet - Espécie boleto;

cptCheck - Espécie cheque;

cptPOS - Espécie  POS;
cptPaperTicket - Espécie ticket;

cptAgreement - Espécie convênio;

cptPromissoryNote - Espécie nota promissório;

cptFinancialCredit - Espécie crédito financeira;

cptWorthDebit - Espécie vale débito;
cptWorthCredit - Espécie vale crédito;

cptDigitalWallet - Espécie carteira digital;

• Valor - Valor a ser cobrado pelo PDV

Tipo = Currency

Permite nulo = Sim, o valor só será necessário na operação de pagamento.

ESTRURA DO JSON

{
    "version": 1,
    "sale": null,
    "pay": null,
    "return": {
        "code": 0
    },
    "execution": "cetContinue",
    "interpret": {
        "commandType": "cctPay",
        "messageCommand": null,
        "options": null,
        "value": null,
        "pay": {
            "value": 10,
            "paymentTypes": [
            ],
            "operation": "optPayment"
        }
    },
    "vouchersPrint": [
    ]
}

{
    "version": 1,
    "sale": null,
    "pay": null,
    "return": {
        "code": 0
    },
    "execution": "cetContinue",
    "interpret": {
        "commandType": "cctPay",
        "messageCommand": null,
        "options": null,
        "value": null,
        "pay": {
            "value": 10,
            "paymentTypes": [
            ],
            "operation": "optReversal",
            "iDPayment": "123456789"
        }
    },
    "vouchersPrint": [
    ]
}

OPERAÇÃO NO PDV

Para indicar que houve uma operação de pagamento solicitada pela Custom API, será gerado um novo documento com a espécie "CE". Na operação de estorno, será gerado um novo documento com a espécie "CS".

A operação de estorno será apenas para cancelar a operação anterior de pagamento, caso exista uma operação de TEF terá que solicitar o estorno manual utilizando a função Cancelamento do TEF do PDV.

Para está operação é importante configurar um Código de movimento para a exportação correta com o financeiro.

DEMAIS INFORMAÇÕES

Atualizar para a versão 22.07.002 ou superior.

ASSUNTOS RELACIONADOS

Código de movimento.