Restituição

Por meio das funcionalidades abaixo é possível recuperar restituição (devolução a crédito) referente a um pagamento que foi realizado.

Listar restituições de um pagamento

Funcionalidade permite listar as restituições associadas a um pagamento.

Solicitamos o campo:

CampoDescriçãoFormatoObrigatório
endToEndIdIdentificador da transação de pagamento de origemstringSim

Resposta:

Campo

Descrição

Formato

Nullable

endToEndId

Identificador da transação de pagamento de origem

string

Não

restituicoes

Detalha a(s) restituições(s)

object (list)

Sim

restituicao

Detalha uma restituição

objeto

Sim

restituicao.Id

Identificador da restituição

String

Não

restituicao.rtrId

Identificador da devolução (RtrId)

String

Não

restituicao.dataRestituicao

Data e hora em que ocorreu o recebimento da transação

date-time

Não

restituicao.valorRestituicao

Valor da transação recebida

double

Não

restituicao.statusRestituicao

Status da restituição

String

Não

restituicao.codigoMotivo

Código da devolução, que pode ser: MD06, FR01, BE08, SL02 ou Devolução Interna

String

Não

restituicao.MotivoRestituicao

Motivo da restituição, de acordo com o código recebido:

  • *BE08**: Restituição MED por falha operacional;
  • *FR01**: RestituiçãoMED por fraude
  • *MD06**: Restituição de pagamento solicitado pelo usuário recebedor
  • *Devolução Interna**: Restituição realizada entre contas do BS2
  • *SL02 **: Restituição no âmbito do Pix Saque e Troco

String

Não

restituicao.pagador

Detalha os dados do pagador

object

Não

restituicao.recebedor

Detalha os dados do recebedor

object

Não

Pagamentos - Consultar - Restituições

Consultar restituição

Funcionalidade permite consultar uma restituição específica.

Solicitamos o campo:

CampoDescriçãoFormatoObrigatório
rtrIdIdentificador da transação de restituiçãostringSim

Resposta:

Campo

Descrição

Formato

Nullable

endToEndId

Identificador da transação de pagamento de origem

string

Não

restituicoes

Detalha a(s) restituições(s)

object (list)

Sim

restituicao

Detalha uma restituição

objeto

Sim

restituicao.Id

Identificador da restituição

String

Não

restituicao.rtrId

Identificador da devolução (RtrId)

String

Não

restituicao.dataRestituicao

Data e hora em que ocorreu o recebimento da transação

date-time

Não

restituicao.valorRestituicao

Valor da transação recebida

double

Não

restituicao.statusRestituicao

Status do recebimento

String

Não

restituicao.codigoMotivo

Código da devolução, que pode ser: MD06, FR01, BE08, SL02 ou Devolução Interna

String

Não

restituicao.MotivoRestituicao

Motivo da restituição, de acordo com o código recebido:

  • *BE08**: Restituição MED por falha operacional;
  • *FR01**: RestituiçãoMED por fraude
  • *MD06**: Restituição de pagamento solicitado pelo usuário recebedor
  • *Devolução Interna**: Restituição realizada entre contas do BS2
  • *SL02 **: Restituição no âmbito do Pix Saque e Troco

String

Não

restituicao.pagador

Detalha os dados do pagador

object

Não

restituicao.recebedor

Detalha os dados do recebedor

object

Não

Pagamentos - Consultar - Restituição