Criar devolução para Pix recebido

Através desse endpoint será possível criar uma devolução para um Pix recebido utilizando o indentificador global (EndToEndId) de uma transação Pix recebida.

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

HEADERS

authorization* string
Bearer token de autenticação.

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

x-stone-idempotency-id* string
Para garantir idempotência das operações.

PATH PARAMS

e2eid* string

id* string
Identificador do pagamento.

Format: [a-zA-Z0-9]{1,35}

BODY PARAMS

valor* string
Valor a ser devolvido. Deve ser igual ou inferior ao valor da transação original.
Format: \d{1,10}.\d{2}

Exemplo body:

{
  "valor": "7.89"
}

Response

201 OK

{
  "id": "123456",
  "rtrId": "D12345678202009091000abcde123456",
  "valor": "7.89",
  "horario": {
    "solicitacao": "2020-09-11T15:25:59.411Z"
  },
  "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.",
  "violacoes": [{
    "propriedade": "valor",
    "razao": "tem seu formato inválido",
    "valor": "invalid"
  },
  {
    "propriedade": "id",
    "razao": "tem seu formato inválido",
    "valor": "@@@@"
  }]
}

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."
}

404 Not Found

{
  "type": "https://pix.bcb.gov.br/api/v2/error/NaoEncontrado",
  "title": "Não Encontrado",
  "status": 404,
  "detail": "Entidade não encontrada."
}

Última modificação: 17.08.2022