19 - Consultar Devolução de Recurso

Scopes:

api.pix api.recurso.devolver

Consulta o status de uma devolução Pix específica.

cURL

curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.com.br/api/Recurso/Devolver/Status/{codigoTransacao} \
  --header 'Authorization: <api-key>'

200

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoTransacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Por meio deste endpoint, o parceiro pode verificar o status da devolução. O sistema trará o status da devolução.

Requisito

Para consulta do status da devolução, é primordial informar o código da transação.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

Endpoint	Mensagem de erro
/api/Recurso/Devolver/Status/	PIX não encontrado

Autorizações

Authorization · string · header · obrigatório

Copie 'Bearer ' + token

Parâmetros de caminho

codigoTransacao · string<uuid> · obrigatório

Identificador UUID da devolução Pix.

Resposta

200

application/json

Success

sucesso · boolean

mensagem · string | null

codigoTransacao · string<uuid> | null

situacaoPix · enum<integer>

Opções disponíveis: 1, 2