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 |
|---|---|
| Identificador único da conta. |
| Nome da conta. |
| Data e hora da criação da conta. |
| Data e hora da última atualização/edição da conta. |
| Indica se a conta pode receber pagamentos. |
| Indica se a conta está verificada. |
| Status da última solicitação de verificação da conta. |
| Dados da última solicitação de verificação da conta. |
| Feedback da última solicitação de verificação da conta. |
| Tipo de mudança de plano. |
| Período de teste das assinaturas, em dias. |
| Dias de faturamento das assinaturas. |
| Indica se os e-mails estão desativados para esta conta. |
| Data e hora do último saque. |
| E-mail de resposta. |
|
|
| Indica se a conta é um marketplace (estrutura de subcontas). |
| URL padrão que o cliente é redirecionado após pagamento. Substituído se |
|
|
| Indica se a conta aplica multas em suas faturas |
| Multa por atraso de pagamento. |
| Indica se a conta aplica juros por dia de atraso. |
| Indica se a conta utiliza a Antecipação de recebíveis antiga. |
| Indica se a conta aplica desconto por pagamento antecipado. |
| Número de dias para considerar para aplicar desconto por pagamento antecipado. |
| Percentual de desconto por pagamento antecipado. |
| Telefone de atendimento ao cliente. |
| E-mail de atendimento ao cliente. |
| Lista de informações adicionais da conta. Cada item da lista possui as propriedades |
| Lista de contas bancárias associadas à conta. Cada item da lista possui as propriedades |
| Indica se o saque automático está ativo. |
| Indica se o saque está desativado. |
| Indica se a notificação por e-mail de pagamento está ativada. |
| E-mail do destinatário das notificações de pagamento. |
| Indica se a Antecipação de recebíveis está ativa. |
| Tipo de Antecipação de recebíveis. |
| Opção de Antecipação de recebíveis. |
| Saldo da conta. |
| Saldo em protesto. |
| Saldo disponível para saque. |
| Saldo protegido. |
| Saldo a pagar. |
| Saldo a receber. |
| Saldo de comissões (Split de Pagamento). |
| Volume de transações do mês anterior. |
| Volume de transações do mês atual. |
| Total de assinaturas. |
| Total de assinaturas ativas. |
| Impostos pagos no mês anterior. |
| Impostos pagos no mês atual. |
| Indica se há domicílio bancário associado à conta. |
| Permissões da conta. |
| URL do logotipo personalizado. |
| URL do logotipo personalizado em tamanho pequeno. |
| Lista de descontos por pagamento antecipado. |
| Comissões associadas à conta. |
| Dados de contato da conta, incluindo |
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 |
