v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Informações da Conta

Retorna as informações de uma conta. Use o LIVE_API_TOKEN da sub-conta na autenticação.

get/accounts/{id}

Path parameters

idstring required

ID da sub-conta

Query parameters

paramstring

Headers

paramstring

Response

200

idstring

namestring

created_atstring

updated_atstring

can_receive?boolean

is_verified?boolean

{"stackTrail":"paths:/accounts/{id}:get:responses:200:content:application/json:schema:properties:last_verification_request_status","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/{id}:get:responses:200:content:application/json:schema:properties:last_verification_request_data","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/{id}:get:responses:200:content:application/json:schema:properties:last_verification_request_feedback","oasType":"schema","type":"unknown"}

change_plan_typeinteger

subscriptions_trial_periodinteger

subscriptions_billing_daysinteger

disable_emailsboolean

{"stackTrail":"paths:/accounts/{id}:get:responses:200:content:application/json:schema:properties:last_withdraw","oasType":"schema","type":"unknown"}

reply_tostring

webapp_on_test_modeboolean

marketplaceboolean

default_return_urlstring

credit_card_verifiedboolean

finesboolean

late_payment_fineinteger

per_day_interestboolean

old_advancementboolean

early_payment_discountboolean

{"stackTrail":"paths:/accounts/{id}:get:responses:200:content:application/json:schema:properties:early_payment_discount_days","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/{id}:get:responses:200:content:application/json:schema:properties:early_payment_discount_percent","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/{id}:get:responses:200:content:application/json:schema:properties:sac_phone","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/accounts/{id}:get:responses:200:content:application/json:schema:properties:sac_email","oasType":"schema","type":"unknown"}

auto_withdrawboolean

disabled_withdrawboolean

payment_email_notificationboolean

payment_email_notification_receiverstring

auto_advanceboolean

auto_advance_typestring

{"stackTrail":"paths:/accounts/{id}:get:responses:200:content:application/json:schema:properties:auto_advance_option","oasType":"schema","type":"unknown"}

balancestring

balance_in_proteststring

balance_available_for_withdrawstring

subaccounts_negative_balance_totalstring

protected_balancestring

customer_minimum_balance_centsinteger

payable_balancestring

receivable_balancestring

commission_balancestring

volume_last_monthstring

volume_this_monthstring

total_subscriptionsinteger

total_active_subscriptionsinteger

taxes_paid_last_monthstring

taxes_paid_this_monthstring

has_bank_address?boolean

{"stackTrail":"paths:/accounts/{id}:get:responses:200:content:application/json:schema:properties:permissions","oasType":"schema","type":"unknown"}

custom_logo_urlstring

custom_logo_small_urlstring

early_payment_discountsobject[]

{"stackTrail":"paths:/accounts/{id}:get:responses:200:content:application/json:schema:properties:commissions","oasType":"schema","type":"unknown"}

Example response

{
  "id": "1234567890ABCDEF1234567890ABCDEF",
  "name": "Test Company",
  "created_at": "2023-10-16T15:44:18-03:00",
  "updated_at": "2024-08-20T09:28:08-03:00",
  "can_receive?": true,
  "is_verified?": true,
  "change_plan_type": 1,
  "subscriptions_billing_days": 5,
  "reply_to": "no-reply@example.com",
  "marketplace": true,
  "credit_card_verified": true,
  "late_payment_fine": 1,
  "old_advancement": true,
  "informations": [
    {
      "key": "account_limit_profile",
      "value": "group_4"
    }
  ],
  "configuration": {
    "payment_email_notification_receiver": "notification@example.com",
    "auto_advance": true,
    "auto_advance_type": "daily",
    "owner_emails_to_notify": "john.doe@example.com,jane.doe@example.com",
    "late_payment_fine": 1,
    "bank_slip": {
      "active": true,
      "extra_due": "2",
      "reprint_extra_due": "2"
    },
    "credit_card": {
      "active": true,
      "soft_descriptor": "DESC*",
      "installments": true,
      "max_installments": "12",
      "max_installments_without_interest": "1",
      "two_step_transaction": true
    },
    "pix": {
      "active": true
    }
  },
  "bank_accounts": [
    {
      "branch": "0001",
      "number": "1234567",
      "digit": "0"
    }
  ],
  "payment_email_notification_receiver": "notification@example.com",
  "auto_advance": true,
  "auto_advance_type": "daily",
  "balance": "R$ 100,00",
  "balance_in_protest": "R$ 0,00",
  "balance_available_for_withdraw": "R$ 100,00",
  "subaccounts_negative_balance_total": "R$100,00",
  "protected_balance": "R$ 0,00",
  "customer_minimum_balance_cents": 3000,
  "payable_balance": "R$ -10,00",
  "receivable_balance": "R$ 20,00",
  "commission_balance": "R$ 0,00",
  "volume_last_month": "R$ 50,00",
  "volume_this_month": "R$ 70,00",
  "total_subscriptions": 30,
  "total_active_subscriptions": 8,
  "taxes_paid_last_month": "R$ 0,00",
  "taxes_paid_this_month": "R$ 0,00",
  "has_bank_address?": true,
  "custom_logo_url": "https://example.com/logo-big.png",
  "custom_logo_small_url": "https://example.com/logo-small.png",
  "splits": [
    {
      "d": "937D2E094342491083DA34DDD2735C9C",
      "split_id": "F81629A2CF17445DAC4BF5A6FCF559CE",
      "recipient_account_id": "C24E35B45BEF4BD8A89A57092B51A9D8",
      "bank_slip_cents": 9,
      "pix_cents": 109,
      "permit_aggregated": true,
      "created_at": "2024-07-15T16:42:54-03:00",
      "updated_at": "2024-07-15T16:42:54-03:00",
      "credit_card_1x_percent": 0.09,
      "credit_card_2x_percent": 0.1
    }
  ],
  "contact_data": {
    "name": "iugu Serviços na Internet S/A",
    "document_number": "15111975000164",
    "full_address": "Av. Paulista, 1048, Quinto andar, Bela Vista, São Paulo/SP, 01310100"
  }
}