v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Configurar Conta

Configura parâmetros de uma conta de pagamentos.

post/accounts/configuration

Headers

Request-Timestring date-time required

Timestamp do momento que enviar a requisição de assinatura digital (RSA)

Signaturestring required

Assinatura Digital

Request body

auto_withdrawboolean

Saque automático?

auto_withdraw_typestring

Periodicidade da agenda: daily, weekly, biweekly ou monthly.<br> Quando presente, ativa a agenda. Ausente ou vazio, desativa.

auto_withdraw_optioninteger

Depende do auto_withdraw_type. Para weekly e biweekly: dia da semana de 1 a 5 (1= Segunda, 2= Terça, 3= Quarta, 4= Quinta, 5= Sexta). Para monthly: dia do mês de 1 a 31. Não se aplica a daily.

auto_withdraw_anchor_datestring

Apenas biweekly: data de referência (início do ciclo) que define quais semanas são ativas. (Formato: 'AAAA-MM-DD'). <br> Obrigatória para biweekly; ignorada para os demais tipos.

per_day_interestboolean

Juros de mora?

finesboolean

Multas?

late_payment_fineinteger

Valor da multa em % (Ex: 2)

auto_advanceboolean

Antecipação Automática. Só pode ser atribuído caso a conta tenha a funcionalidade de Novo Adiantamento habilitado (entre em contato com o Suporte para habilitar). Caso o parâmetro não seja enviado, considera-se a mesma configuração de adiantamento automático da conta mestre.

auto_advance_typestring

Opções de Antecipação Automática. Obrigatório caso auto_advance seja true. Recebe os valores 'daily' (Antecipação diária), 'weekly' (Antecipação semanal, que ocorre no dia da semana determinado pelo usuário), 'monthly' (Antecipação mensal, que ocorre no dia do mês determinado pelo usuário) e 'days_after_payment' (Antecipação que ocorre em um número de dias após o pagamento especificado pelo usuário)

auto_advance_optioninteger

Obrigatório caso auto_advance seja true e auto_advance_type diferente de 'daily'. Em caso de auto_advance_type = weekly, recebe valores de 0 a 6 (Número correspondente ao dia da semana que a antecipação será realizada, 0 para domingo, 1 para segunda e assim por diante). Em caso de auto_advance_type = monthly, recebe valores de 1 a 28 (Número correspondente ao dia do mês que a antecipação será realizada). Em caso de auto_advance_type = days_after_payment, recebe valores de 1 a 30 (Número de dias após o pagamento em que a antecipação será realizada)

payment_email_notificationboolean

boolean Ativa ou desativa a notificação de pagamento

payment_email_notification_receiverstring

Email que deve receber as notificações de pagamento (Obrigatório caso payment_email_notification seja true)

early_payment_discountboolean

Ativa ou desativa o desconto por pagamento antecipado

disabled_withdrawboolean

Desabilita saque da conta

customer_minimum_balance_centsstring

Configuração de valor para reserva de saque

Response

200

idstring

namestring

created_atstring

updated_atstring

can_receive?boolean

is_verified?boolean

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

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

{"stackTrail":"paths:/accounts/configuration:post: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/configuration:post: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/configuration:post:responses:200:content:application/json:schema:properties:early_payment_discount_days","oasType":"schema","type":"unknown"}

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

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

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

{"stackTrail":"paths:/accounts/configuration:post:responses:200:content:application/json:schema:properties:informations","oasType":"schema","type":"unknown"}

auto_withdrawboolean

disabled_withdrawboolean

payment_email_notificationboolean

payment_email_notification_receiverstring

auto_advanceboolean

auto_advance_typestring

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

balancestring

balance_in_proteststring

balance_available_for_withdrawstring

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/configuration:post: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/configuration:post:responses:200:content:application/json:schema:properties:commissions","oasType":"schema","type":"unknown"}

Example response

{
  "id": "12345ABCDE67890FGHIJK12345LMNOPQR",
  "name": "ACME Teste Produto e Integrações",
  "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@acme.com",
  "marketplace": true,
  "credit_card_verified": true,
  "late_payment_fine": 1,
  "old_advancement": true,
  "configuration": {
    "payment_email_notification_receiver": "finance@acme.com",
    "auto_advance": true,
    "auto_advance_type": "daily",
    "owner_emails_to_notify": "john.doe@acme.com,jane.smith@acme.com,bob.brown@acme.com,alice.white@acme.com",
    "late_payment_fine": 1,
    "bank_slip": {
      "active": true,
      "extra_due": "2",
      "reprint_extra_due": "2"
    },
    "credit_card": {
      "active": true,
      "soft_descriptor": "ACME 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": "8"
    }
  ],
  "payment_email_notification_receiver": "finance@acme.com",
  "auto_advance": true,
  "auto_advance_type": "daily",
  "balance": "R$ 58,03",
  "balance_in_protest": "R$ 0,00",
  "balance_available_for_withdraw": "R$ 58,03",
  "protected_balance": "R$ 0,00",
  "customer_minimum_balance_cents": 3000,
  "payable_balance": "R$ -2,47",
  "receivable_balance": "R$ 13,53",
  "commission_balance": "R$ 0,00",
  "volume_last_month": "R$ 8,00",
  "volume_this_month": "R$ 17,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://s3-sa-east-1.amazonaws.com/storage.acme.com/custom_logos/12345abcde67890fghijk12345lmnopqr-big?AWSAccessKeyId=EXAMPLEKEY&Expires=1724157249&Signature=EXAMPLESIGNATURE",
  "custom_logo_small_url": "https://s3-sa-east-1.amazonaws.com/storage.acme.com/custom_logos/12345abcde67890fghijk12345lmnopqr-small?AWSAccessKeyId=EXAMPLEKEY&Expires=1724157249&Signature=EXAMPLESIGNATURE",
  "splits": [
    {
      "id": "ABCDE12345FGHIJ67890KLMNOPQRSTUV",
      "split_id": "WXYZ1234567890ABCDEFGHIJKL",
      "recipient_account_id": "MNOPQRSTUV1234567890ABCDEFGHIJK",
      "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": "ACME Corp",
    "document_number": "00000000000123",
    "full_address": "123 Fictional Street, Suite 100, Metropolis, SP, 00000000"
  }
}