Decodificar QR Code

Sandbox

https://horizon-api-sb.app.rpe.tech

POST

/api/v1/pixcard/qrCode/decodificar

Use este endpoint para decodificar o QR Code.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/qrCode/decodificar' \
--header 'Accept: */*' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idAccount": 1634554,
    "codeContent": "00020101021226920014br.gov.bcb.pix2570api-h.developer.btgpactual.com/v1/q/d/23a9b4a9c654444396168b6fade38b6c52040000530398654071010.505802BR5913Reinaldo Bode6009Sao Paulo62410503***50300017BR.GOV.BCB.BRCODE01051.0.0630471D3",
    "contentType": 0,
    "datePayment": "2024-12-04T12:05:39.502Z"
}'

Response Example

200 - Exemplo 1

{
    "pixType": "TRANSFER",
    "codeType": 0,
    "transferType": 0,
    "idEndToEnd": "E04038166201907261559y6j6mt9l0pi",
    "idTx": "DOCK202001030000000000099",
    "ispb": "12345678",
    "bankName": "Banco 01",
    "bankAccountNumber": "3214324",
    "bankBranchNumber": "124",
    "bankAccountType": "CC",
    "key": "[email protected]",
    "beneficiaryType": "F",
    "agentWithdrawalIspb": "1234",
    "nationalRegistration": "039677030295",
    "payeeName": "Maria Sousa",
    "city": "João Pessoa",
    "zipCode": "6800000",
    "finalAmount": 120,
    "details": "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 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

Parâmetros Bodyapplication/json

idAccount

integer <int64>

requerido

Identificador da conta.

>= 1<= 14

Exemplo:

1634554

codeContent

string

requerido

Conteúdo do QR Code.

Exemplo:

00020101021226920014br.gov.bcb.pix2570api-h.developer.btgpactual.com/v1/q/d/23a9b4a9c654444396168b6fade38b6c52040000530398654071010.505802BR5913Reinaldo Bode6009Sao Paulo62410503***50300017BR.GOV.BCB.BRCODE01051.0.0630471D3

contentType

integer <int32>

requerido

Formato de QR Code a ser decodificado.

0 = EMV

1 = Texto Base64

2 = Imagem Base64

Exemplo:

datePayment

string <date-time>

opcional

Data do pagamento, no formato YYYY-MM-DD.

Exemplo:

2024-12-04T12:05:39.502Z

Examples

Respostas

🟢200OK

application/json

Body

opcional

Responde para decodificação do código do QR Code estático.

Exemplo:

{"pixType":"TRANSFER","codeType":0,"transferType":0,"idEndToEnd":"E04038166201907261559y6j6mt9l0pi","idTx":"DOCK202001030000000000099","ispb":"12345678","bankName":"Banco 01","bankAccountNumber":"3214324","bankBranchNumber":"124","bankAccountType":"CC","key":"[email protected]","beneficiaryType":"F","agentWithdrawalIspb":"1234","nationalRegistration":"039677030295","payeeName":"Maria Sousa","city":"João Pessoa","zipCode":"6800000","finalAmount":120,"details":"Informações adicionais"}

codeType

integer <int32>

opcional

Tipo do QR Code decodificado. Onde 0 = QR Code estático.

Exemplo:

transferType

enum<integer> <int32>

opcional

Mecanismo usado na transferência. Onde 2 = QR Code estático.

0 = Manual

1 = Chave Pix

2 = QR Code estático

3 = QR Code dinâmico

Valores permitidos:

0123

Exemplo:

idEndToEnd

string

opcional

Identificador end-to-end.

Exemplo:

E04038166201907261559y6j6mt9l0pi

idTx

string

opcional

Identificador para conciliação do recebedor.

Exemplo:

DOCK202001030000000000099

ispb

string

opcional

Identificador de Sistema de Pagamentos Brasileiro.

<= 8 Caracteres

Exemplo:

12345678

bankName

string

opcional

Nome do banco.

Exemplo:

Banco 01

bankAccountNumber

string

opcional

Número da conta bancária.

Exemplo:

3214324

bankBranchNumber

string

opcional

Número da agência bancária.

Exemplo:

124

bankAccountType

enum<string>

opcional

Tipo da conta bancária.

CC = conta corrente

PA = conta de pagamento

SA = conta poupança

Valores permitidos:

CCPASA

Exemplo:

key

string

opcional

Chave Pix (DICT) usada na transação.

Exemplo:

[email protected]

beneficiaryType

enum<string>

opcional

Tipo de beneficiário.

F = CPF

J = CNPJ

Valores permitidos:

Exemplo:

nationalRegistration

string

opcional

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

>= 11 Caracteres<= 14 Caracteres

Exemplo:

039677030295

payeeName

string

opcional

Nome do beneficiário.

Exemplo:

Maria Sousa

city

string

opcional

Cidade.

Exemplo:

João Pessoa

zipCode

string

opcional

Código postal.

Exemplo:

6800000

finalAmount

number <double>

opcional

Valor final da transação.

Exemplo:

120

details

string

opcional

Informações adicionais.

Exemplo:

Informações adicionais

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Página anterior

Criar QR Code estático

Próxima página

Confirmar reivindicações