Listar devoluções

Use este endpoint para listar as transações de devolução.

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/transferencias//devolucao' \ --header 'Accept: */*' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Content-Type: application/json'

{ "idAccount": 1, "idEndToEndOriginal": "E04038166201907261559y6j6mt9l0p3", "idEndToEndReturn": "E04022166201907261559y6j6mt9l0pi", "transactionDate": "2024-01-23T22:10:05.025Z", "transactionType": "TRANSFER_DEBIT", "errorType": 1, "transactionStatus": "EXECUTED", "debitParty": { "ispb": 12345678, "bankName": "Banco 002", "nationalRegistration": "12997703045", "name": "Maria Oliveira", "bankBranchNumber": "001", "bankAccountType": "CC", "bankAccountNumber": "9090001", "key": "teste@teste.com" }, "creditParty": { "ispb": 12345678, "bankName": "Banco 003", "nationalRegistration": "03467793045", "name": "Maria Silva", "bankBranchNumber": "12", "bankAccountType": "CC", "bankAccountNumber": "12456700" }, "amount": 100, "tariffAmount": 0, "finalAmount": 100, "reversalCode": 1, "reversalReason": "Outros motivos", "idAdjustment": 12, "transactionCode": "3345324", "payerAnswer": "Informações adicionais" }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

idTransacao

string

requerido

identificador da transação, gerado pelo sistema parceiro.

Exemplo:

2001

Parâmetros Header

string

requerido

Tipo de conteúdo aceito.

Exemplo:

*/*

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Respostas

🟢200OK

application/json

Body

idAccount

integer <int32>

opcional

Identificador da conta.

>= 1<= 14

idEndToEndOriginal

string

opcional

Identificador end-to-end da transação original.

<= 32 Caracteres

Exemplo:

E04038166201907261559y6j6mt9l0p3

idEndToEndReturn

string

opcional

Identificador end-to-end da devolução.

<= 32 Caracteres

Exemplo:

E04022166201907261559y6j6mt9l0pi

transactionDate

string <date-time>

opcional

Data da transação.

Exemplo:

2024-01-23T22:10:05.025Z

transactionType

enum<string>

opcional

Tipo da transferência.

TRANSFER_DEBIT= transferência de débito

TRANSFER_CREDIT = transferência de crédito

Valores permitidos:

TRANSFER_DEBITTRANSFER_CREDIT

Exemplo:

TRANSFER_DEBIT

errorType

enum<integer> <int32>

opcional

Tipo do erro ocorrido durante a transação. Retornado quando transactionStatus = NOT_EXECUTED

Tipo	Erro
1	Transação Pix recusada pelo PSP recipiente
2	Dados do recipiente não validos pelo PSP recipiente
3	Timeout
4	Erro inesperado durante transação

Valores permitidos:

1234

Exemplo:

transactionStatus

enum<string>

opcional

Status da transação.

EXECUTED = efetuada

NOT_EXECUTED = não efetuada

PENDING = pendente

REVERSAL_EXECUTED = retornada

Valores permitidos:

EXECUTEDNOT_EXECUTEDPENDINGREVERSAL_EXECUTED

Exemplo:

PENDING

debitParty

object

opcional

Informações de débito.

ispb

integer <int32>

opcional

Identificador de Sistema de Pagamentos Brasileiro.

<= 8

Exemplo:

12345678

bankName

string

opcional

Nome do banco.

<= 60 Caracteres

Exemplo:

Banco 002

nationalRegistration

string

opcional

Número do documento de registro, a depender do campo beneficiaryType.

>= 11 Caracteres<= 14 Caracteres

Exemplo:

12997703045

name

string

opcional

Nome.

<= 100 Caracteres

Exemplo:

Maria Oliveira

bankBranchNumber

string

opcional

Número da agência bancária.

Exemplo:

001

bankAccountType

enum<string>

opcional

Tipo da conta bancária.

CC = conta corrente

PA = conta de pagamento

SA = conta poupança

Valores permitidos:

CCPASA

Exemplo:

bankAccountNumber

string

opcional

Número da conta bancária.

>= 1 Caracteres<= 20 Caracteres

Exemplo:

9090001

key

string

opcional

Chave usada na transferência.

Exemplo:

teste@teste.com

creditParty

object

opcional

Informações de crédito.

ispb

integer <int32>

opcional

Identificador de Sistema de Pagamentos Brasileiro.

<= 8

Exemplo:

12345678

bankName

string

opcional

Nome do banco.

<= 60 Caracteres

Exemplo:

Banco 003

nationalRegistration

string

opcional

Número do documento de registro, a depender do campo beneficiaryType.

>= 11 Caracteres<= 14 Caracteres

Exemplo:

03467793045

name

string

opcional

Nome.

<= 100 Caracteres

Exemplo:

Maria Silva

bankBranchNumber

string

opcional

Número da agência bancária.

Exemplo:

bankAccountType

enum<string>

opcional

Tipo da conta bancária.

CC = conta corrente

PA = conta de pagamento

SA = conta poupança

Valores permitidos:

CCPASA

Exemplo:

bankAccountNumber

string

opcional

Número da conta bancária.

>= 1 Caracteres<= 20 Caracteres

Exemplo:

12456700

amount

number <double>

opcional

Valor a ser devolvido. Não incluindo taxas, descontos e juros.

<= 100

Exemplo:

100

tariffAmount

integer <int32>

opcional

Valor da taxa de devolução.

>= 0<= 10

Exemplo:

finalAmount

number <double>

opcional

Valor final da devolução. Inclui descontos, juros e taxas.

<= 10

Exemplo:

100

reversalCode

enum<integer>

opcional

Código de devolução.

Código	Motivo
0	Pagamento duplicado
1	Devolução por valor recebido ser divergente do valor esperado
2	Devolução causada por erro PSP* Return due to a PSP error
3	Devolução causada por problemas técnicos que resultaram numa transação incorreta Return after technical problems, resulting in an incorrect transaction;
4	Devolução após solicitação de cancelamento da transação
5	Devolução por suspeita de fraude
6	Devolução após usuário receber pagamento original
7	Devolução após solicitação de investigação
8	Recipiente não está incluído na lista de pessoas autorizadas (allowlist) para efetuar transações com o pagador
9	Recipiente está incluído na lista de usuário bloqueados (denylist) do pagador
10	Ordem de pagamento não justificada
11	Código de erro genérico usado apenas quando o motivo da devolução não foi definido ou não foi estabelecido pelos códigos previamente listados

Valores permitidos:

1234567891011

Exemplo:

reversalReason

string

opcional

Motivo da devolução com informações não listadas no código de devolução.

Exemplo:

Outros motivos

idAdjustment

integer <int32>

opcional

Identificador do ajuste.

>= 0

Exemplo:

transactionCode

string

opcional

Código de transação. Gerado mesmo se o pagamento não for efetuado.

Exemplo:

3345324

payerAnswer

string

opcional

Campo para inclusão de informações adicionais.

Exemplo:

Informações adicionais

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor