Pular para o conteúdo principal
POST
/
v1
/
refunds
curl --request POST \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endToEndId": "E12345678202501011200000001",
  "accountId": "12345678-1234-1234-1234-123456789012",
  "transactionId": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "code": "FR01",
  "amount": 100.5,
  "description": "Fraudulent transaction detected"
}
'
{
  "id": "refund_123456789",
  "accountId": "acc_123456789",
  "code": "MD06",
  "endToEndId": "E1234567820230615123456789012345",
  "endToEndRefundId": "D1234567820230615987654321098765",
  "amount": 100.5,
  "description": "Requested by receiver",
  "status": "PENDING",
  "createdAt": "2023-06-15T11:00:00Z"
}

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).

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:

"12345678-1234-1234-1234-123456789012"

​
transactionId
string<uuid>
obrigatório

Identificador da transacao original a ser estornada.

Exemplo:

"01989f9e-6508-79f8-9540-835be49fbd0d"

​
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"