---
# System prepended metadata

title: Unlimint API

---

# Unlimint API

Documentação: https://integration.unlimint.com/

## Fluxo de pay-in
- No contexto deles, é chamado de **payments**.
- Possuem três tipos principais de pagamento:
    - Bank Card
    - Cryptocurrency
    - Gateway mode (transações bancárias)
- O interessante para nós é o **Gateway Mode**. Nele podemos criar Deposit Orders ("pedidos de depósito") em ~~alguns bancos~~ diferentes formas ao redor do mundo, todos listados [aqui](https://integration.unlimint.com/#payment-methods).
- Na América Latina, eles oferecem as seguintes formas:

    | País | Formas de Pagamento |
    | --------- | -------------- |
    | Argentina | Mercado Pago |
    | Brasil | Boleto, Deposit Express Brasil, Loterica, PIX, QR code PicPay, Mercado Pago |
    | Chile | Mercado Pago |
    | Colômbia | Efecty, Davivienda, Baloto, PSE, Mercado Pago |
    | Equador | Pago Efectivo, Convenience stores |
    | México | OXXO, SPEI, Codi, Mercado Pago, Convenience stores|
    | Peru | Pago Efectivo, Mercado Pago, Convenience stores |
     
- Ao acessar o endpoint de criação do pedido de depósito, é retornado todas as informações necessárias de acordo com a forma de pagamento escolhida.
- Para identificar se o depósito foi consolidado, temos que verificar o status do pedido de depósito criado usando outro endpoint. 
- Não há notificação assíncrona no fluxo.


## Fluxo de pay-out
- No contexto deles, tambem é chamado de **payout**.
- O fluxo é simples:
    - Um pedido de pagamento é criado com todos os dados necessários
    - Eles tentam efetivar o pagamento
    - A efetivação do pagamento é identificada verificando o status do pagamento em outro endpoint.
- Os tipos de payouts disponíveis está listado [aqui] (https://integration.unlimint.com/#Payout-methods).
- Na América Latina, o payout está disponível somente em moeda local e em:
    - Argentina
    - Brasil
    - Colômbia
    - México
    - Peru
- Chile e Equador não estão disponíveis para payouts.

## Conclusões
- Visando a nossa expansão na América Latina, eles oferecem o serviço bancário que nos interessa em **Colômbia, México e Peru**.
- Os fluxos se encaixam com o nosso e é possível integrarmos na API deles para acelerar nossas operação nos países acima citados.
- Para a integração, será necessária apenas pequenas mudanças em nossa API para retornar os dados bancários no momento da criação de um DepositOrder e, claro, um adapter para se comunicar com a API deles.
