Listar status de transferência

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

{ "idAccount": 10751, "idEndToEnd": "E08744817202112010805AVJYQCTMAZI", "transactionDate": "2021-12-01T08:07:27.874Z", "transactionType": "TRANSFER_DEBIT", "transactionStatus": "EXECUTED", "transferType": 0, "errorType": 1, "debitParty": { "ispb": 12345678, "bankName": "DOCK SOLUCOES EM MEIOS DE PAGAMENTO S A", "nationalRegistration": "03967702145", "name": "Vizir Testing", "bankBranchNumber": "1031", "bankAccountType": "CC", "bankAccountNumber": "10310751" }, "creditParty": { "ispb": 12345678, "bankName": "DOCK SOLUCOES EM MEIOS DE PAGAMENTO S A", "nationalRegistration": "03967453045", "name": "Vizir Testing", "bankBranchNumber": "0001", "bankAccountType": "CC", "bankAccountNumber": "10310751", "key": "4004901d-bd85-4769-8e52-cb4c42c506dc" }, "amount": 565.83, "tariffAmount": 0, "finalAmount": 565, "idAdjustment": 1376892, "transactionCode": "ff19b493-01f4-4550-9af1-d1d42f8146ce", "tariffTransactionCode": "string", "idTx": "ef02e3e027114aeeb76efa19a5f121d1", "payerAnswer": "Teste transfer QA", "pixType": "TRANSFER", "purchaseAmount": "string", "changeAmount": "5.5", "agentWithdrawalIspb": "string", "agentMode": "AGPSS", "amountDetails": { "original": 717.61, "fees": { "fine": 5, "interest": 24, "abatement": 156.23, "discount": 40 }, "finall": 746.61 }, "details": [ { "title": "Multa por valor fixo.", "content": "5.0" } ] }

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.

<= 36 Caracteres

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.

Exemplo:

10751

idEndToEnd

string

opcional

Identificador end-to-end.

Exemplo:

E08744817202112010805AVJYQCTMAZI

transactionDate

string <date-time>

opcional

Data da transação.

Exemplo:

2021-12-01T08:07:27.874Z

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

transactionStatus

enum<string>

opcional

Status da transação.

EXECUTED = efetuada

PENDING =

NOT_EXECUTED = não efetuada

Valores permitidos:

EXECUTEDPENDINGNOT_EXECUTED

Exemplo:

PENDING

transferType

enum<integer> <int32>

opcional

Tipo de transferência.

0 = Manual

1 = Chave Pix

2 = QR Code estático

3 = QR Code dinâmico

Valores permitidos:

0123

Exemplo:

errorType

enum<integer> <int32>

opcional

Tipo do erro, exibido quando transactionStatus = NOT_EXECUTED.

Tipo	Erro
1	Pagamento cancelado por timeout
2	Transação interrompida por erro no agente de pagamento
3	Número da conta de pagamento inválido ou ausente
4	Conta bloqueada, transações com a conta estão proibidas
5	Número da conta de pagamento está fechado
6	Tipo da conta de pagamento ausente ou inválido
7	Tipo de transação não suportado ou autorizado para esta conta
8	ISPB não identificado
9	Valor especificado é igual a zero
10	Sem limite disponível para a transação
11	Valor recebido não corresponde ao valor esperado ou acordado
12	Quantidade de transações informada é inválida ou ausente.
13	Informações do cliente final divergentes com o número da conta
14	Identificador do pagador incorreto
15	Conteúdo incorreto
16	Transação rejeita pelo banco (motivos relacionados ao conteúdo)
17	Signatário não tem permissão para assinar este tipo de operação
18	Data e hora de criação incorretas
19	Informações de pagamento, mensagem associada à transação ou transação recebida após data de processamento ou data anterior
20	Acordo falhou ou possui identificador EndToEnd duplicado
21	Identificador EndToEnd ausente ou inválido
22	Informações de beneficiário ausentes ou inválidas
23	Informações de devedor ausentes ou inválidas

Valores permitidos:

1234567891011121314151617181920212223

Exemplo:

debitParty

object

opcional

Informações de débito.

ispb

integer <int32>

opcional

Identificador de Sistema de Pagamentos Brasileiro.

Exemplo:

12345678

bankName

string

opcional

Nome do banco.

<= 60 Caracteres

Exemplo:

DOCK SOLUCOES EM MEIOS DE PAGAMENTO S A

nationalRegistration

string

opcional

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

>= 11 Caracteres<= 14 Caracteres

Exemplo:

03967702145

name

string

opcional

Nome.

<= 100 Caracteres

Exemplo:

Vizir Testing

bankBranchNumber

string

opcional

Número da agência bancária.

>= 1 Caracteres<= 4 Caracteres

Exemplo:

10310751

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:

10310751

creditParty

object

opcional

Informações de crédito.

ispb

integer <int32>

opcional

Identificador de Sistema de Pagamentos Brasileiro.

Exemplo:

12345678

bankName

string

opcional

Nome do banco.

<= 60 Caracteres

Exemplo:

DOCK SOLUCOES EM MEIOS DE PAGAMENTO S A

nationalRegistration

string

opcional

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

>= 11 Caracteres<= 14 Caracteres

Exemplo:

03967453045

name

string

opcional

Nome.

<= 100 Caracteres

Exemplo:

Vizir Testing

bankBranchNumber

string

opcional

Número da agência bancária.

>= 1 Caracteres<= 4 Caracteres

Exemplo:

0001

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:

10310751

key

string

opcional

Chave usada na transferência.

Exemplo:

4004901d-bd85-4769-8e52-cb4c42c506dc

amount

number <double>

opcional

Valor da transferência, excluindo taxas, descontos e juros.

Exemplo:

565.83

tariffAmount

number <double>

opcional

Valor das taxas.

>= 0<= 10

Exemplo:

finalAmount

number <double>

opcional

Valor final da transferência, incluindo taxas, juros e descontos.

<= 10

Exemplo:

565.83

idAdjustment

integer <int32>

opcional

Identificador do ajuste.

>= 0

Exemplo:

1376892

transactionCode

string

opcional

Código da transação, gerado mesmo quando o pagamento não for efetuado.

Exemplo:

ff19b493-01f4-4550-9af1-d1d42f8146c0

tariffTransactionCode

string

opcional

Código da taxa de transação, gerado mesmo quando o pagamento não for efetuado.

idTx

string

opcional

Identificador para conciliação do recebedor.

Exemplo:

ef02e3e027114aeeb76efa19a5f121d1

payerAnswer

string

opcional

Resposta do pagador.

Exemplo:

Teste transfer QA

pixType

enum<string>

opcional

Tipo do Pix.

TRANSFER = transferência

CHANGE = troco

WITHDRAWAL = resgate

Valores permitidos:

TRANSFERCHANGEWITHDRAWAL

Exemplo:

TRANSFER

purchaseAmount

string

opcional

Valor disponível para o cliente. Presente apenas quando pixType = CHANGE.

changeAmount

string

opcional

Valor de troco resultado da transação.

Exemplo:

5.5

agentWithdrawalIspb

string

opcional

ISPB do agente usado no saque.

<= 8 Caracteres

agentMode

enum<string>

opcional

Tipo da agência.

AGPSS = facilitador de serviço de saque, também chamado de AGPSS

AGTEC = agente de saque estabelecimento comercial

AGTOT = caixas eletrônicos compartilhados ou correspondentes no país

Valores permitidos:

AGPSSAGTECAGTOT

Exemplo:

AGPSS

amountDetails

object

opcional

Detalhes do valor.

original

number <double>

opcional

Valor original.

Exemplo:

717.61

fees

object

opcional

Taxas e impostos.

finall

number <double>

opcional

Valor final.

Exemplo:

746.61

details

array [object {2}]

opcional

Detalhes da transferência.

title

string

opcional

Título.

Exemplo:

Multa por valor fixo.

content

string

opcional

Conteúdo.

Exemplo:

5.0

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor