Skip to main content
POST

Autorizações

​
Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Cabeçalhos

​
Idempotency-Key
string

Chave de idempotencia opcional para retentativas seguras (padrao IETF). Use um UUID v4 ou identificador de negocio unico. Se a mesma chave for enviada novamente e a requisicao original ja tiver sido processada, a resposta em cache e retornada.

Consulte Retentativas e idempotencia para mais detalhes.

Corpo

application/json
​
endToEndId
string
obrigatório

Identificador ponta a ponta da transacao original a ser estornada.

Exemplo:

"E12345678202501011200000001"

​
accountId
string<uuid>
obrigatório

Identificador da conta solicitando o estorno.

Exemplo:

"019c96a0-0c0c-7221-8cf3-13313fb60081"

​
transactionId
string<uuid>
obrigatório

Identificador da transacao original a ser estornada.

Exemplo:

"019c96a0-0a98-7287-9a31-786e0809c769"

​
code
enum<string>
obrigatório

Codigos de motivo de estorno conforme definido pelo Banco Central do Brasil (BACEN). Codigos padronizados utilizados ao solicitar estornos de transacoes.

Valores validos:

  • FR01 = Fraude (Transacao identificada como fraudulenta)
  • AC03 = Conta do credor invalida (Conta do destinatario e invalida ou nao existe)
  • AG01 = Transacao proibida (Tipo de transacao nao permitido para esta conta)
  • MD06 = Estorno solicitado pelo recebedor (Beneficiario solicitou o estorno)
  • BE01 = Dados inconsistentes (Dados da transacao contem inconsistencias)
  • AC07 = Conta encerrada (Conta do destinatario foi encerrada)
Opções disponíveis:
FR01,
AC03,
AG01,
MD06,
BE01,
AC07
Exemplo:

"MD06"

​
amount
number<double>
obrigatório

Valor do estorno (nao deve exceder o valor da transacao original).

Exemplo:

100.5

​
description
string
obrigatório

Descricao do motivo do estorno.

Exemplo:

"Refund requested by receiver"

Resposta

Estorno criado com sucesso

​
id
string
obrigatório

Identificador unico do estorno.

Exemplo:

"refund_123456789"

​
accountId
string
obrigatório

Identificador da conta associada ao estorno.

Exemplo:

"acc_123456789"

​
code
enum<string>
obrigatório

Codigos de motivo de estorno conforme definido pelo Banco Central do Brasil (BACEN). Codigos padronizados utilizados ao solicitar estornos de transacoes.

Valores validos:

  • FR01 = Fraude (Transacao identificada como fraudulenta)
  • AC03 = Conta do credor invalida (Conta do destinatario e invalida ou nao existe)
  • AG01 = Transacao proibida (Tipo de transacao nao permitido para esta conta)
  • MD06 = Estorno solicitado pelo recebedor (Beneficiario solicitou o estorno)
  • BE01 = Dados inconsistentes (Dados da transacao contem inconsistencias)
  • AC07 = Conta encerrada (Conta do destinatario foi encerrada)
Opções disponíveis:
FR01,
AC03,
AG01,
MD06,
BE01,
AC07
Exemplo:

"MD06"

​
endToEndId
string
obrigatório

Identificador ponta a ponta da transacao original que foi estornada.

Exemplo:

"E1234567820230615123456789012345"

​
endToEndRefundId
string
obrigatório

Identificador ponta a ponta do estorno.

Exemplo:

"D1234567820230615987654321098765"

​
amount
number<double>
obrigatório

Valor do estorno.

Exemplo:

100.5

​
description
string
obrigatório

Descricao do motivo do estorno.

Exemplo:

"Requested by receiver"

​
status
string
obrigatório

Status do estorno.

Exemplo:

"PENDING"

​
createdAt
string<date-time>
obrigatório

Data e hora de criacao do estorno.

Exemplo:

"2023-06-15T11:00:00Z"