Pix on Documentação Orus

1 - Cobranças

Thu, 12 Sep 2024 17:02:12 +0000

É possível gerar uma cobrança para terceiro, que utilizará o “Pix Copia e Cola” ou o Qrcode para efetivar uma transferência. Uma cobrança pode ser paga inúmeras vezes; o valor pode ou não ser fixo, podendo ser definido no momento da criação; não é possível atualizar um qrcode estático; não possui data de vencimento.

1.0 - Gerar pix cobrança

[POST] /api/v1/pix/gerarcobranca

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
amount	Valor da cobrança Pix	Não	Number
description	Descrição da cobrança	Não	String
pix_key	chave pix	Não	String

{
 "amount":1000,
 "description": "Pix teste",
 "pix_key": "01234567890"
}

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Indica se a operação foi executada com sucesso	Boolean
code	Código de retorno da operação	Number
qrcode_url	URL da imagem do QR Code gerado	String
qrcode_digitable	Código Pix Copia e Cola da cobrança	String
id	Identificador único da cobrança	String
amount	Valor da cobrança	Number
description	Descrição da cobrança	String
description_customer	Descrição exibida ao pagador	String
callback_url	URL de callback configurada para a cobrança	String
proof_url	URL do comprovante da cobrança	String
url_linkpublico	Link público para visualização da cobrança	String
taxa_amount	Valor da taxa aplicada à cobrança	Number

{
 "success": true,
 "code": 200,
 "qrcode_url": "https://sandbox-storage.exemplo.com/images/3f9d7c12-8b6a-4bde-9c10-7e8f4a2d1b55/8a7d9f3c2e1b4d5f9a6c7e8b1d2f3a4b.svg",
 "qrcode_digitable": "00020126580014br.gov.bcb.pix0136f8b3c9d2-7a5e-4b1c-9d2e-123456789abc5204000053039865802BR5406100.005925EMPRESA EXEMPLO LTDA6009SAO PAULO61080100000062070503***6304ABCD",
 "id": "9f3b1d52-2d4f-4d6a-b9a1-8c7e5f3d2a10",
 "amount": "100.00",
 "description": "Recebimento de Cobrança Pix",
 "description_customer": "Deposito-1234",
 "callback_url": null,
 "proof_url": null,
 "url_linkpublico": "https://sandbox.exemplo.com/pix/9f3b1d52-2d4f-4d6a-b9a1-8c7e5f3d2a10",
 "taxa_amount": 0
}

2.0 Consultar Cobrança

[GET]/charge/{charge}

Este endpoint tem a responsabilidade de consultar a cobrança, com ou sem vencimento, e retornar os dados da cobrança.

1 - Domínios

Thu, 12 Sep 2024 17:04:12 +0000

Os domínios são valores que identificam um atributo em determinado contexto do sistema.

1.0 - DOMÍNIOS DE ERROS

Erro	Descrição
SPI1	Falha ao se comunicar com SPI
G404	Nenhum registro encontrado
G406	Informações fornecidas já existentes na base
G422	Sem permissão para tomar ação.
G422	Sem permissão para tomar ação.
ACC404	Owner não encontrado
QR403	Falha ao gerar qrcode
QR404	QrCode não encontrado
P01	Payload inválido
DICT404	Chave pix não identificada
DICT01	Chave pix já cadastrada em outro banco
IN01	EndToEnd do pagamento não encontrado.

1.1 - Tipo de iniciação de pix

Iniciação de um determinado pagamento ou recebimento pix.

2 - Fluxogramas

Thu, 12 Sep 2024 17:03:12 +0000

Esses fluxogramas visam descrever os processos de:

2.2 - Processamento síncronos dos liquidantes .

O processo de enviar pix e receber pix, dependendo do liquidante, exige uma comunicação síncrona entre o período de envio ou recebimento. Esses processos são:

2.2.1 - Fluxo de recebimento de pix

2.2.2 - Fluxo de envio de pix.

2.3 - Reivindicação de chave

3 - Limites

Thu, 12 Sep 2024 13:53:12 +0000

3.0 Conceituação

3.1 - Consultar limites

Este endpoint permite consultar os limites transacionais disponíveis para a conta do cliente autenticado. A resposta retorna os valores atualmente configurados para cada tipo de operação, como transferências TED, transações Pix e pagamentos de boletos. Essas informações podem ser utilizadas para validar os limites disponíveis antes da realização de uma operação financeira.

[GET] /api/v1/account/limits

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
message	Mensagem da operação	String
limits	Limites disponíveis por operação	Object
limits.ted	Limite disponível para TED	Number
limits.pix	Limite disponível para transações Pix	Number
limits.boleto	Limite disponível para boletos	Number
code	Código de sucesso	Number

{
 "success": true,
 "message": "Limites consultados",
 "limits": {
 "ted": 1000,
 "pix": 2000,
 "boleto": 0
 },
 "code": 200
}

3.2 - Solicitar novos limites (ted,p2p,boleto)

Este endpoint permite solicitar o aumento dos limites transacionais da conta para operações de TED, transferências P2P e pagamentos de boletos. Para análise da solicitação, é obrigatório informar os novos limites desejados e anexar um documento comprobatório em formato Base64. Após o envio, a solicitação será registrada e encaminhada para validação, podendo ser aprovada ou recusada de acordo com os critérios definidos pela instituição.

2 - Transferências e ordem de pagamentos

Thu, 12 Sep 2024 15:02:12 +0000

Nessa seção será descrito os endpoints relacionados ao pix.

⚠️ É necessário realizar a confirmação de token antes de realizar o pix: 3 - Autenticação de dois fatores pelo endpoint 3.3

2.0 - Enviar Pix

[POST] /api/payconductor/sendWithdrawal

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
amount	Valor do Pix a ser enviado	Sim	Number
payoutAccount	Dados da conta de destino	Sim	Object
payoutAccount.pixKey	Chave Pix do recebedor	Sim	String
payoutAccount.pixType	Tipo da chave Pix (Cpf, Cnpj, Email, Phone, Evp)	Sim	String

{
 "amount": 80,
 "payoutAccount": {
 "pixKey": "12345678909",
 "pixType": "Cpf"
 }
}

[RESPONSES]

Código Descrição

200 Sucesso

400 Erro

Propriedade	Descrição	Tipo
message	Mensagem de retorno da operação	String
data	Objeto com os dados da transação	Object
data.amount	Valor da transação	Number
data.payer	Dados do pagador	Object
data.payer.name	Nome do pagador	String
data.payer.document	CPF ou CNPJ do pagador	String
data.payer.bankIspb	ISPB do banco do pagador	String
data.payer.bankAccount	Conta do pagador	String
data.payer.bankBranch	Agência do pagador	String
data.payer.bankName	Nome do banco do pagador	String
data.receiver	Dados do recebedor	Object
data.receiver.name	Nome do recebedor	String
data.receiver.document	CPF ou CNPJ do recebedor	String
data.receiver.bankIspb	ISPB do banco do recebedor	String
data.receiver.bankAccount	Conta do recebedor	String
data.receiver.bankBranch	Agência do recebedor	String
data.receiver.bankName	Nome do banco do recebedor	String
data.e2e	Identificador end-to-end da transação Pix	String

{
 "message": "pix enviado com sucesso",
 "data": {
 "amount": 1000,
 "payer": {
 "name": "João da Silva",
 "document": "12345678901",
 "bankIspb": "string",
 "bankAccount": "string",
 "bankBranch": "string",
 "bankName": "string"
 },
 "receiver": {
 "name": "João da Silva",
 "document": "12345678901",
 "bankIspb": "string",
 "bankAccount": "string",
 "bankBranch": "string",
 "bankName": "string"
 },
 "e2e": "E9F3A1C2B4D5E6F7089A1B2C3D4E5F60"
 }
}

Propriedade	Descrição	Tipo
status	Indica que a operação falhou	Boolean
message	Mensagem descritiva do erro	String

{
 "status": false,
 "message": "Não foi possível concluir a transação"
}

5 - Pix Dict

Mon, 12 Sep 2022 13:52:12 +0000

5.0 - Conceituação

DICT - Diretório de identificadores de Contas Transacionais. Utiliza apelidos para identificar as contas transacionais, conhecidos como chave pix. Com esses “apelidos” facilita-se a identificação e envio de valores entre contas.

Os endpoints permitem o cadastramento e gerenciamento das chaves pix, bem como sua reivindicação;

Os tipos possíveis de chaves pix se encontram na seção 1.4 - Tipos de chaves pix

5.1 - Cadastrar chave pix

Para cadastros de chave tipo email e telefone, é necessário antes de realizar o cadastro, requisitar autoridade por meio do endpoint: 5.2 - Tipos de chaves pix e depois confirmar a autoridade por meio do endpoint: 1.4 - Tipos de chaves pix

Pix on Documentação Orus

1 - Cobranças

1.0 - Gerar pix cobrança

[HEADER]

[PAYLOAD]

[RESPONSES]

2.0 Consultar Cobrança

1 - Domínios

1.0 - DOMÍNIOS DE ERROS

1.1 - Tipo de iniciação de pix

2 - Fluxogramas

2.2 - Processamento síncronos dos liquidantes .

2.2.1 - Fluxo de recebimento de pix

2.2.2 - Fluxo de envio de pix.

2.3 - Reivindicação de chave

3 - Limites

3.0 Conceituação

3.1 - Consultar limites

[HEADER]

[RESPONSES]

3.2 - Solicitar novos limites (ted,p2p,boleto)

2 - Transferências e ordem de pagamentos

2.0 - Enviar Pix

[HEADER]

[PAYLOAD]

[RESPONSES]

5 - Pix Dict

5.0 - Conceituação

5.1 - Cadastrar chave pix