Devolução

Informações sobre Devoluções da API Open Finance Efí

Efetuar uma devolução de um pagamento

Este endpoint é utilizado para realizar a devolução de um pagamento.

POST /v1/pagamentos/pix/:identificadorPagamento/devolver

Requer autorização para o escopo: gn.opb.payment.pix.refund

Requisição

Devolução

{
  "valor": "0.01"
}

Respostas

As respostas abaixo representam Sucesso(202) e Falhas/erros do consumo.

🟢 202

Processando devolução
{
  "identificadorPagamento": "urn:efi:ae71713f-875b-4af3-9d85-0bcb43288847",
  "valorDevolucao": "0.01",
  "dataCriacao": "2022-10-28 10:02:25",
  "status": "pendente"
}

🔴 400

Erro na requisição
{
  "nome": "identificador_pagamento_obrigatorio",
  "mensagem": "O campo identificadorPagamento é obrigatório"
}

Ou

{
  "nome": "valor_devolucao_invalido",
  "mensagem": "O valor de devolução inválido"
}

🔴 422

Erro na requisição
{
  "nome": "identificador_pagamento_invalido",
  "mensagem": "O identificador de pagamento é inválido"
}

Ou

{
  "nome": "status_pagamento_invalido_para_devolucao",
  "mensagem": "O status do pagamento é invalido para devolução"
}

Ou

{
  "nome": "saldo_devolucao_insuficiente",
  "mensagem": "O valor da devolução ultrapassou o valor recebido"
}

Ou

{
  "nome": "saldo_insuficiente",
  "mensagem": "O saldo em conta é insuficiente para efetuar esta transação"
}

🔴 500

Erro no servidor
{
  "nome": "erro_aplicacao",
  "mensagem": "Erro interno do servidor"
}

Cancelar um pagamento agendado

Este endpoint é utilizado para cancelar um pagamento agendado

PATCH /v1/pagamentos/pix/:identificadorPagamento/cancelar

Requer autorização para o escopo: gn.opb.payment.pix.cancel

Requisição

A requisição enviada para esse endpoint não precisa de um body, apenas os cabeçalhos de autorização OAuth, parâmetros e o certificado da conta.

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

🟢 200

{
  "pagamentos": {
    "identificadorPagamento": "urn:efi:ae71713f-875b-4af3-9d85-0bcb43288847",
    "dataCancelamento": "2023-08-16 10:02:25",
    "status": "cancelado"
  }
}

🔴 400

{
  "nome": "identificador_pagamento_obrigatorio",
  "mensagem": "O campo identificadorPagamento é obrigatório"
}

🔴 422

{
  "nome": "identificador_pagamento_invalido",
  "mensagem": "O identificador do pagamento é inválido"
}

🔴 500

{
  "nome": "erro_aplicacao",
  "mensagem": "Erro interno do servidor"
}