Consultar devolução de Pix

Através desse endpoint será possível exibir os detalhes de uma devolução realizada para uma transferência Pix. Os status possíveis para a devolução poderão ser:

EM_PROCESSAMENTO - a devolução ainda está em processamento
DEVOLVIDO - concluído com sucesso
NAO_REALIZADO - a devolução foi rejeitada

GET https://sandbox-api.openbank.stone.com.br/api/v1/pix/{end_to_end_id}/devolucao/{id}

HEADERS

authorization* string
Bearer token de autenticação.

x-stone-account-id* string
Necessário para permissionamento.

PATH PARAMS

e2eid* string

id* uuid

Response

200 OK

{
  "endToEndId": "E12345678202009091221abcdef12345",
  "txid": "cd1fe328c875481285a6f233ae41b662",
  "valor": "100.00",
  "horario": "2020-09-10T13:03:33.902Z",
  "infoPagador": "Reforma da casa",
  "devolucoes": [
    {
      "id": "000AAA111",
      "rtrId": "D12345678202009091000abcde123456",
      "valor": "11.00",
      "horario": {
        "solicitacao": "2020-09-10T13:03:33.902Z"
      },
      "status": "EM_PROCESSAMENTO"
    }
  ]
}

400 Bad Request

{
  "type": "https://pix.bcb.gov.br/api/v2/error/PixConsultaInvalida",
  "title": "Consulta Pix Inválida",
  "status": 400,
  "detail": "Os parâmetros de consulta à lista de pix recebidos não respeitam o schema ou não fazem sentido semanticamente."
}

403 Forbidden

{
  "type": "https://pix.bcb.gov.br/api/v2/error/AcessoNegado",
  "title": "Acesso Negado",
  "status": 403,
  "detail": "Requisição de participante autenticado que viola alguma regra de autorização."
}

Última modificação: 19.09.2021