Pular para o conteúdo
Vintém

Consultar devolução

GET
/pix/{e2eid}/devolucao/{id}
curl --request GET \
  --url http://localhost:8080/pix/example/devolucao/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Seção intitulada “Authorizations”

Parameters

Seção intitulada “Parameters”

Path Parameters

Seção intitulada “Path Parameters”
e2eid
required
string
/^[a-zA-Z0-9]{32}$/
id
required
string
/^[a-zA-Z0-9]{1,35}$/

Escolhido pelo cliente; identifica a devolução junto com o e2eid.

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

Devolução.

Media typeapplication/json
object
id
required
string
rtrId

Identificador da devolução no SPI, gerado pelo banco.

string
valor
required
string
/^\d{1,10}\.\d{2}$/
natureza
required
string
Allowed values: ORIGINAL RETIRADA
descricao
string
horario
required
object
solicitacao
required
string format: date-time
liquidacao
string format: date-time
status
required
string
Allowed values: EM_PROCESSAMENTO DEVOLVIDO NAO_REALIZADO
motivo

Por que a devolução não foi realizada.

string

Example 

{
  "valor": "10.50",
  "natureza": "ORIGINAL",
  "status": "EM_PROCESSAMENTO"
}

401

Seção intitulada “401”

API key ausente ou inválida.

Media typeapplication/problem+json

Erro no formato da spec do BCB (RFC 7807).

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
correlationId
string
violacoes
Array<object>
object
razao
string
propriedade
string
valor
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "correlationId": "example",
  "violacoes": [
    {
      "razao": "example",
      "propriedade": "example",
      "valor": "example"
    }
  ]
}

403

Seção intitulada “403”

A API key não tem o escopo necessário.

Media typeapplication/problem+json

Erro no formato da spec do BCB (RFC 7807).

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
correlationId
string
violacoes
Array<object>
object
razao
string
propriedade
string
valor
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "correlationId": "example",
  "violacoes": [
    {
      "razao": "example",
      "propriedade": "example",
      "valor": "example"
    }
  ]
}

404

Seção intitulada “404”

Recurso não encontrado.

Media typeapplication/problem+json

Erro no formato da spec do BCB (RFC 7807).

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
correlationId
string
violacoes
Array<object>
object
razao
string
propriedade
string
valor
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "correlationId": "example",
  "violacoes": [
    {
      "razao": "example",
      "propriedade": "example",
      "valor": "example"
    }
  ]
}

default

Seção intitulada “default”

Qualquer outro erro, sempre como Problema. Os mais comuns: 502 quando o banco recusa ou falha (PSPIndisponivel) e 500 para erro interno.

Media typeapplication/problem+json

Erro no formato da spec do BCB (RFC 7807).

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
correlationId
string
violacoes
Array<object>
object
razao
string
propriedade
string
valor
string

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "correlationId": "example",
  "violacoes": [
    {
      "razao": "example",
      "propriedade": "example",
      "valor": "example"
    }
  ]
}