Izipay NOW Documentation

🌎 Scroll down for the English version

Olá desenvolvedor! Essa página irá ajudá-lo a iniciar sua integração com a API da Izipay

Conteúdo:

🚀 Introdução
▶️ Comece aqui
🔐 Autorizações (Authorization token)
✍️ Exemplos de retornos
🤔 Precisa de ajuda?

🚀 Introdução

Seu parceiro financeiro.

Somos a Izipay NOW - sua plataforma financeira especializada em soluções de pagamento. Com um serviço personalizado e dedicado, estamos aqui para atender às suas necessidades exclusivas.

Confie no PIX como seu método de pagamento ágil e seguro, respaldado pelas mais avançadas práticas de conformidade e prevenção de fraudes.

Simplifique a sua gestão financeira com contas e subcontas virtuais, tudo isso acessível através de uma interface intuitiva e completa.

A equipe Izipay dispõe de um atendimento de suporte único e exclusivo para atender nossos clientes, todas as demandas e necessidades são levadas em consideração para que você tenha um projeto completo e de muito sucesso entre nossa parceria.

▶️ Comece Aqui

Esses são passos para começar o uso da API da Izipay:

Criação de Conta: Nosso time irá criar uma conta personalizada para você e seu próprio time, com todos os acessos e credenciais necessários.

Autorização: Use um token válido no Headers para enviar requests para os endpoints da API.

Acesso: Você pode ter sub contas com diferentes tipos de acesso.

🔐 Autorizações

A Izipay NOW usa um token para segurar a autorização

Você deve usar esse token em cada request à API via Postman no campo authorization que se encontra no Headers.

✍️ Exemplos de Retornos

Nossa documentação traz muitas possibilidades de retornos que você pode receber em cada requisição.

Saque:

Situação	Código	Mensagem
Transação Realizada	400	payload { "transfer_request_id": "", "created_at": "2024-07-08T12:39:51-03:00", "amount_cents": 70, "transfer_type": "pix", "end_to_end_id": "", "external_reference": "", "status": "processing", "transaction_id": "" }
Usuário não encontrado	400	Session expired or invalid token
Usuário com aprovação pendente	400	Waiting for account approval
Usuário suspenso	400	Suspensed user, contact administration
Usuário bloqueado	400	Blocked user
Código PIN incorreto	400	Invalid PIN code. Try again
Formato inválido para o campo "valor"	400	Amount is not a valid integer
Sem campo "valor" no objeto JSON	400	Amount is missing in the JSON data
Valor de saque igual ao valor de saldo	400	You cannot withdraw all your balance due to fees. Try Withdrawing a smaller amount
Valor de saque menor que valor de saldo	400	Your current balance is BALANCE_VALUE and you are trying to withdraw AMOUNT_VALUE
Saque + Fee maior ou igual ao valor de saldo	400	You cannot withdraw all your balance due to fees. Try Withdrawing a smaller amount
Erro Genérico	400	Could not process the payment. Try again later.

Depósito:

Situação	Código	Mensagem
Transação Realizada	200	payload { qr_code_value: qrCode.pix.qrcode_text, expiration_datetime: qrCode?.due_date, status: "GENERATED", transaction_id: transactionId, order_id: externalReference, }
Usuário não encontrado	400	Session expired or invalid token
Usuário com aprovação pendente	400	Waiting for account approval
Usuário suspenso	400	Suspensed user, contact administration
Usuário bloqueado	400	Blocked user
Valor menor que R$1,00	400	Total amount lower than R$ 1.00 is not allowed
Sem campo "valor" no objeto JSON	400	Amount is missing in the JSON data
Falha ao criar QR Code	400	Could not generate QR Code. Try again later
Erro genérico	400	Could not generate QR Code. Try again later

🤔 Precisa de Ajuda?

O time da Izipay NOW quer ter a certeza que a sua equipe tenha tudo o que precisa para fazer uma intregração de sucesso com a nossa aplicação. Se precisar de ajuda, não hesite em procurar nosso suporte contato@izipaynow.com.

🚀 Introduction

Your Loyal Financial Partner.

We are Izipay NOW - your specialized financial platform for payment solutions. With personalized and dedicated service, we are here to meet your unique needs. Trust in PIX as your agile and secure payment method, backed by the most advanced compliance and fraud prevention practices.

Simplify your financial management with virtual accounts and subaccounts, all accessible through an intuitive and comprehensive interface.

The Izipay team offers unique and exclusive customer support to meet our clients' needs. All demands and requirements are taken into consideration to ensure a successful and comprehensive project within our partnership.

▶️ Get Started

Steps to get started with the Izipay API:

Create Account: Our team will set up a personalized account for you and your own team, with all the access and crendentials needed.

Authorization: Use a valid token at Headers to send requests to the API endpoints.

Access: You can have sub accounts with different kind of access.

🔐 Authorization

Izipay NOW uses a token for authorization.

You must include this token in each request to the Postman API with the authorization request header.

✍️ Responses Example

We have documented many of the possible responses you might encounter using examples under each request.

Withdraw:

Situation	Code	Message
Transaction completed		payload { "transfer_request_id": "", "created_at": "2024-07-08T12:39:51-03:00", "amount_cents": 70, "transfer_type": "pix", "end_to_end_id": "", "external_reference": "", "status": "processing", "transaction_id": "" }
User not found		Session expired or invalid token
User with pending approval		Waiting for account approval
Suspended user	400	Suspensed user, contact administration
Blocked user		Blocked user
Invalid PIN		Invalid PIN code. Try again
invalid "amount" format		Amount is not a valid integer
Field "amount" is missing in the JSON data		Amount is missing in the JSON data
The withdraw amount is the same as your balance		You cannot withdraw all your balance due to fees. Try Withdrawing a smaller amount
The withdraw amount is higher than you balance		Your current balance is BALANCE_VALUE and you are trying to withdraw AMOUNT_VALUE
Withdraw amount + Fees is higher or the same as your balance		You cannot withdraw all your balance due to fees. Try Withdrawing a smaller amount
Generic error		Could not process the payment. Try again later.