Descrição das propriedades do response do endpoint Informações da Conta — GET v1/accounts/{id}
Notas de Atualização
Atualizado em 15/08/2024
- Adição de todas as propriedades.
| Propriedade | Descrição |
|---|---|
id | Identificador único da conta. |
name | Nome da conta. |
created_at | Data e hora da criação da conta. |
updated_at | Data e hora da última atualização/edição da conta. |
can_receive? | Indica se a conta pode receber pagamentos. |
is_verified? | Indica se a conta está verificada. |
last_verification_request_status | Status da última solicitação de verificação da conta. |
last_verification_request_data | Dados da última solicitação de verificação da conta. |
last_verification_request_feedback | Feedback da última solicitação de verificação da conta. |
change_plan_type | Tipo de mudança de plano. |
subscriptions_trial_period | Período de teste das assinaturas, em dias. |
subscriptions_billing_days | Dias de faturamento das assinaturas. |
disable_emails | Indica se os e-mails estão desativados para esta conta. |
last_withdraw | Data e hora do último saque. |
reply_to | E-mail de resposta. |
webapp_on_test_mode | Depreciado ❌ Indica se o aplicativo web está em modo de teste. |
marketplace | Indica se a conta é um marketplace (estrutura de subcontas). |
default_return_url | URL padrão que o cliente é redirecionado após pagamento. Substituído se return_url do endpoint Criar Fatura for informado. |
credit_card_verified | Depreciado ❌ Indica se o recurso cartão de crédito está verificado. |
fines | Indica se a conta aplica multas em suas faturas |
late_payment_fine | Multa por atraso de pagamento. |
per_day_interest | Indica se a conta aplica juros por dia de atraso. |
old_advancement | Indica se a conta utiliza a Antecipação de recebíveis antiga. |
early_payment_discount | Indica se a conta aplica desconto por pagamento antecipado. |
early_payment_discount_days | Número de dias para considerar para aplicar desconto por pagamento antecipado. |
early_payment_discount_percent | Percentual de desconto por pagamento antecipado. |
sac_phone | Telefone de atendimento ao cliente. |
sac_email | E-mail de atendimento ao cliente. |
informations | Lista de informações adicionais da conta. Cada item da lista possui as propriedades key (chave) e value (valor). |
bank_accounts | Lista de contas bancárias associadas à conta. Cada item da lista possui as propriedades branch (agência), number (número da conta), digit (dígito da conta). |
auto_withdraw | Indica se o saque automático está ativo. |
disabled_withdraw | Indica se o saque está desativado. |
payment_email_notification | Indica se a notificação por e-mail de pagamento está ativada. |
payment_email_notification_receiver | E-mail do destinatário das notificações de pagamento. |
auto_advance | Indica se a Antecipação de recebíveis está ativa. |
auto_advance_type | Tipo de Antecipação de recebíveis. |
auto_advance_option | Opção de Antecipação de recebíveis. |
balance | Saldo da conta. |
balance_in_protest | Saldo em protesto. |
balance_available_for_withdraw | Saldo disponível para saque. |
protected_balance | Saldo protegido. |
payable_balance | Saldo a pagar. |
receivable_balance | Saldo a receber. |
commission_balance | Saldo de comissões (Split de Pagamento). |
volume_last_month | Volume de transações do mês anterior. |
volume_this_month | Volume de transações do mês atual. |
total_subscriptions | Total de assinaturas. |
total_active_subscriptions | Total de assinaturas ativas. |
taxes_paid_last_month | Impostos pagos no mês anterior. |
taxes_paid_this_month | Impostos pagos no mês atual. |
has_bank_address? | Indica se há domicílio bancário associado à conta. |
permissions | Permissões da conta. |
custom_logo_url | URL do logotipo personalizado. |
custom_logo_small_url | URL do logotipo personalizado em tamanho pequeno. |
early_payment_discounts | Lista de descontos por pagamento antecipado. |
commissions | Comissões associadas à conta. |
contact_data | Dados de contato da conta, incluindo name (nome), document_number (número do documento), full_address (endereço completo). |
Objeto configuration
configuration| Subpropriedade | Descrição |
|---|---|
auto_withdraw | Indica se o saque automático está ativado |
disabled_withdraw | Indica se o saque está desativado |
payment_email_notification | Notificação por email de pagamento |
payment_email_notification_receiver | Destinatário da notificação por email de pagamento |
auto_advance | Indica se o adiantamento automático está ativado |
auto_advance_type | Tipo de adiantamento automático |
auto_advance_option | Opção de adiantamento automático |
commission_percent | Percentual de comissão |
owner_emails_to_notify | Emails dos proprietários a serem notificados |
fines | Multas |
late_payment_fine | Multa por atraso no pagamento |
per_day_interest | Juros por dia |
early_payment_discount | Desconto para pagamento antecipado |
early_payment_discount_days | Dias para pagamento antecipado com desconto |
early_payment_discount_percent | Percentual de desconto para pagamento antecipado |
customer_minimum_balance_cents | Valor configurado na conta para reserva de saque |
Propriedade bank_slip
bank_slip| Subpropriedade | Descrição |
|---|---|
active | Indica se o boleto bancário está ativo |
extra_due | Prazo extra para pagamento do boleto |
reprint_extra_due | Prazo extra para 2ª via do boleto |
Propriedade credit_card
credit_card| Subpropriedade | Descrição |
|---|---|
active | Indica se o cartão de crédito está ativo |
soft_descriptor | Descrição curta no extrato do cartão de crédito |
installments | Indica se o Parcelamento está ativo |
installments_pass_interest | Indica se há repasse dos juros do parcelamento |
max_installments | Número máximo de parcelas |
max_installments_without_interest | Número máximo de parcelas sem juros |
two_step_transaction | Indica se Transação em duas etapas está ativo |
Propriedade pix
pix| Subpropriedade | Descrição |
|---|---|
active | Indica se o Pix está ativo |
Propriedade splits
splits| Subpropriedade | Descrição |
|---|---|
id | Identificador do split |
split_id | Identificador da divisão |
recipient_account_id | Identificador da conta do destinatário |
cents | Quantia em centavos |
percent | Percentual da divisão |
credit_card_cents | Centavos se pagamento com cartão de crédito |
credit_card_percent | Percentual se pagamento com cartão de crédito |
bank_slip_cents | Centavos se pagamento com boleto bancário |
bank_slip_percent | Percentual se pagamento com boleto bancário |
pix_cents | Centavos se pagamento com Pix |
pix_percent | Percentual se pagamento com Pix |
permit_aggregated | Se true, permite percentual + cents |
created_at | Data de criação |
updated_at | Data de atualização/edição |
credit_card_1x_cents | Centavos se pagamento com cartão de crédito em 1x |
credit_card_2x_cents | Centavos se pagamento com cartão de crédito em 2x |
credit_card_3x_cents | Centavos se pagamento com cartão de crédito em 3x |
credit_card_4x_cents | Centavos se pagamento com cartão de crédito em 4x |
credit_card_5x_cents | Centavos se pagamento com cartão de crédito em 5x |
credit_card_6x_cents | Centavos se pagamento com cartão de crédito em 6x |
credit_card_7x_cents | Centavos se pagamento com cartão de crédito em 7x |
credit_card_8x_cents | Centavos se pagamento com cartão de crédito em 8x |
credit_card_9x_cents | Centavos se pagamento com cartão de crédito em 9x |
credit_card_10x_cents | Centavos se pagamento com cartão de crédito em 10x |
credit_card_11x_cents | Centavos se pagamento com cartão de crédito em 11x |
credit_card_12x_cents | Centavos se pagamento com cartão de crédito em 12x |
credit_card_1x_percent | Percentual se pagamento com cartão de crédito em 1x |
credit_card_2x_percent | Percentual se pagamento com cartão de crédito em 2x |
credit_card_3x_percent | Percentual se pagamento com cartão de crédito em 3x |
credit_card_4x_percent | Percentual se pagamento com cartão de crédito em 4x |
credit_card_5x_percent | Percentual se pagamento com cartão de crédito em 5x |
credit_card_6x_percent | Percentual se pagamento com cartão de crédito em 6x |
credit_card_7x_percent | Percentual se pagamento com cartão de crédito em 7x |
credit_card_8x_percent | Percentual se pagamento com cartão de crédito em 8x |
credit_card_9x_percent | Percentual se pagamento com cartão de crédito em 9x |
credit_card_10x_percent | Percentual se pagamento com cartão de crédito em 10x |
credit_card_11x_percent | Percentual se pagamento com cartão de crédito em 11x |
credit_card_12x_percent | Percentual se pagamento com cartão de crédito em 12x |
credit_card_13x_cents | Centavos se pagamento com cartão de crédito em 13x |
credit_card_14x_cents | Centavos se pagamento com cartão de crédito em 14x |
credit_card_15x_cents | Centavos se pagamento com cartão de crédito em 15x |
credit_card_16x_cents | Centavos se pagamento com cartão de crédito em 16x |
credit_card_17x_cents | Centavos se pagamento com cartão de crédito em 17x |
credit_card_18x_cents | Centavos se pagamento com cartão de crédito em 18x |