Recipe 🧪

Clique na recipe abaixo e veja, na prática, a sequência de chamadas às APIs:

Mas se preferir a teoria, continue com este artigo!

Criar

Há duas formas de criar uma subconta na iugu:

1. Via Alia

1. Em sua Conta Mestre, acesse alia.iugu.com > Clique em Marketplace

2. No canto superior direito, clique em Nova
3. Preencha todos os campos obrigatórios
4. Defina se haverá ou não Split de Pagamento
5. Defina o nível de acesso
6. Clique em Salvar.

Saiba mais sobre como Criar Subconta via Alia.

2. Via API Criar Subconta

Utilize a rota POST /v1/marketplace/create_account. Não há parâmetros obrigatórios neste endpoint, porém, se o parâmetro name não for informado, o ID da Conta será utilizado por padrão.

Importante ⚠️

Não utilize números nem caracteres especiais no parâmetro name.

Requisição exemplo

curl --request POST \
     --url 'https://api.iugu.com/v1/marketplace/create_account?api_token=1ABC234567890DEF1ABC234567890DEF1ABC234567890DEF1ABC234567890DEF' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"name":"Subconta"}'

Retorno exemplo

{
  "account_id": "1ABC234567890DEF1ABC234567890DEF",
  "name": "Subconta A",
  "live_api_token": "1ABC234567890DEF1ABC234567890DEF1ABC234567890DEF1ABC234567890DEF",
  "test_api_token": "1ABC234567890DEF1ABC234567890DEF1ABC234567890DEF1ABC234567890DEF",
  "user_token": "1ABC234567890DEF1ABC234567890DEF1ABC234567890DEF1ABC234567890DEF",
  "commissions": null
}

Verificar

A verificação é uma etapa imprescindível para começar a transacionar em uma subconta. Para isso, utilize o endpoint Enviar Verificação de Subconta — POST /v1/accounts/{account_id}/request_verification.

🚧

Importante ⚠️

Ao criar uma Subconta via Alia, ela é verificada automaticamente.

Informe os dados obrigatórios. São eles:

Parâmetros obrigatórios de acordo com o preenchimento:

KYC

A partir do momento que a requisição a este endpoint retorna 200 OK, a conta está verificada e já está apta para transacionar. O processo de KYC deve ser realizado pelo seller.

Alterar domicílio bancário

Só é possível verificar contas uma única vez. Portanto, caso precise alterar o Domicílio Bancário de uma conta já verificada, há duas formas:

Via Alia

Consulte o artigo Como cadastrar meu domicílio bancário.

Via API

Utilize o endpoint Adicionar Domicílio Bancário — POST /v1/bank_verification.

Configurar

Há inúmeras configurações que podem ser consideradas ou não. Siga abaixo algumas sugestões de configuração.

Ativar métodos de pagamento

Na iugu, há 3 métodos de pagamento, ative/desative o que desejar. Para todos, há duas formas:

1. Via Alia

Cartão de Crédito

1. Configurações > Cartão de Crédito
2. Marque a caixa de seleção Ativar
3. Clique em Salvar

Boleto Bancário

1. Configurações > Boleto Bancário
2. Marque a caixa de seleção Ativar
3. Clique em Salvar

Pix

1. Configurações > Pix
2. Marque a caixa de seleção Ativar
3. Clique em Salvar

2. Via API Configurar Conta

Utilize o endpoint Configurar Conta — POST /v1/accounts/configuration, informe os parâmetros a seguir e faça a requisição:

Cartão de Crédito

{
  "credit_card": {
    "active": true
  }
}

Boleto Bancário

{
  "bank_slip": {
    "active": true
  }
}

Pix

Utilize o endpoint Ativar/desativar método Pix — POST /v1/payments/pix:

{
  "enable":true
}

Desativar Subconta

Se, por algum motivo, precisar desativar uma subconta, utilize o endpoint Desativar Subconta — POST /v1/marketplace/deactivate. Informe o account_id no URL (path) para a requisição.

Requisição exemplo

curl --request POST \
     --url 'https://api.iugu.com/v1/marketplace/deactivate?api_token=your_api_token' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "account_id": "9A15EA2E3A354B3CB6DFF5D055F2A594"
}
'

Importante ⚠️

Atente-se as informações importantes antes de requisitar este endpoint:

1. Ao requisitar este endpoint, todas as faturas, assinaturas e carnês pendentes serão cancelados e a conta terá o status unverified.
2. A conta não poderá ter saldo.
3. Não poderá reativá-la.
4. A requisição precisa ser feita utilizando o live_api_token da Conta Mestre.