Esta seção exemplifica todos os métodos relacionados a transações e ordem de pagamento.
POST /api/transacao
Endpoint responsável por cadastrar uma ordem de pagamento, retornando o Id da transação em caso de sucesso.
Headers
Content-Type | application/json |
Authorization | Bearer {token} |
Request Body application/json
Schema:
IdEstabelecimento | Int32 | ID que identifica o estabelecimento solicitante da ordem de pagamento | Obrigatório |
IdDispositivo | Int32 | ID que identifica o dispositivo que solicitou a ordem de pagamento | Obrigatório |
IdRedeCredenciadaMetodosPagamento | Int32 | ID que identifica o tipo de venda (Venda Loja: 1) | Obrigatório |
IdEstabelecimentoOperador | Int32 | ID Que identifica o operador que solicitou a ordem de pagamento | Obrigatório |
Valor | Decimal | Valor da ordem de pagamento | Obrigatório |
JSON:
{
"IdEstabelecimento":3,
"idDispositivo":1,
"IdRedeCredenciadaMetodosPagamento":17,
"IdEstabelecimentoOperador":1,
"Valor":30
}Autorização de uma Transação (Identificadores VDLJ1 e VDPT3) e estará disponível apenas para Estabelecimentos Autenticados.
Para efetuar uma Transação Autorizada pelo TMPay, o Parceiro precisa seguir o seguinte fluxo:
Antes de utilizar os métodos dessa sessão, o Parceiro precisa se autenticar e enviar seu Token de Acesso, conforme solicitado nos demais métodos, para então realizar a autenticação do Estabelecimento. Essa autenticação é necessária para configurações de parâmetros de segurança na Câmara de Autorização.
Uma vez credenciado, o Estabelecimento poderá se Autenticar e gerar uma Ordem de Transação através do endpoint Cadastrar Ordem de Transação. Essa Ordem se refere a uma solicitação de venda e nenhuma movimentação financeira ocorre até a autenticação, leitura e confirmação do usuário do TARGET Conta Digital.
Após o cadastro dessa Ordem de Transação, o Estabelecimento poderá acompanhar o Status da mesma através do enpoint Obter Ordem de Transação por IDouObter Ordem de Transação por NSU, assim como solicitar o cancelamento através do endpoint Cancelar Ordem de Transação por IDouCancelar Ordem de Transação por NSU. Caso já tenha ocorrido a movimentação financeira referente à Ordem de Transação, o valor será estornado e o status da Ordem de Transação será Estornada. Do contrário o status da Ordem de Transação será Cancelada.
O Estabelecimento poderá acompanhar todas as vendas realizadas e Autorizadas pelo TMPay através do endpoint Listar Transações por Período.