Definir descrições no extrato com o Connect
Saiba como funcionam as descrições no extrato com o Connect.
As descrições no extrato explicam cobranças ou pagamentos nos extratos bancários e incluem informações exigidas pelos bancos e bandeiras de cartão para ajudar os clientes a entender os extratos. Conheça os requisitos de descrições no extrato.
Definir o componente estático para uma conta conectada
As descrições do extrato contêm um componente estático e, opcionalmente, uma parte dinâmica. O componente estático se refere a:
- Toda a descrição no extrato é estática (settings.payments.statement_descriptor).
- A primeira metade da descrição do extrato é estática (settings.card_payments.statement_descriptor_prefix) e a segunda metade é dinamicamente definida a partir do pagamento.
Sua plataforma e as contas conectadas com a card_
precisam ter uma descrição no extrato e, opcionalmente, um prefixo na descrição no extrato. Ambos os valores precisam ter pelo menos 5 caracteres. Para um determinado pagamento, a descrição no extrato da plataforma ou da conta conectada é aplicada dependendo do tipo de cobrança.
A descrição no extrato é definida de uma das seguintes maneiras:
- Com uma chamada da API criar ou atualizar conta
- Durante o onboarding hospedado ou integrado pela Stripe
- Pelo Stripe Dashboard completo ou Express Dashboard
Contas conectadas com acesso a um Dashboard hospedado pela Stripe podem atualizar as próprias configurações de descrição no extrato.
You can prefill an account’s statement descriptor and prefix when you call the create account endpoint. During Stripe-hosted or embedded onboarding, If settings.
isn’t set, Stripe generates it by concatenating the following strings:
business_
profile. name - “doing business as”
business_
profile. url - the legal entity name (either
individual.
+first_ name individual.
orlast_ name company.
).name
If settings.
isn’t prefilled, Stripe sets it using the first 10 characters of the statement descriptor.
If the required information isn’t available, Stripe-hosted or embedded onboarding prompts the account to set its own statement descriptor and prefix.
Após fazer o onboarding de uma conta que não tem acesso ao Stripe Dashboard completo, você pode atualizar suas settings.
e settings.
chamando o endpoint de atualização da conta.
Para contas em que a plataforma processa onboarding, você precisa definir a descrição no extrato.
A partir da versão de API 2023-10-16, uma nova lógica é utilizada para atualizar descrições no extrato.
- Se você atualizar
business_
,profile. name business_
ou o nome da empresa ou do indivíduo e a descrição no extrato existente for baseada em dados de precedência inferior, a Stripe redefine automaticamente a descrição no extrato para corresponder ao valor de precedência superior. Por exemplo, se a descrição do extrato for definida automaticamente com base no URL, você define ou atualizaprofile. url business_
, a Stripe redefine a descrição no extrato para corresponder ao nome do perfil da empresa. Se a descrição no extrato for definida automaticamente com base emprofile. name business_
e você definir ou atualizar o nome da empresa ou do indivíduo, a descrição no extrato não será redefinida porqueprofile. name business_
tem precedência mais alta. A ordem de precedência éprofile. name business_
,profile. name business_
e o nome da empresa ou do indivíduo.profile. url - Qualquer atualização na descrição no extrato completa de uma conta faz com que a Stripe defina automaticamente o prefixo dessa descrição para uma versão mais curta da descrição no extrato atualizada, mesmo que o prefixo anterior seja definido manualmente.
Uso da descrição no extrato
A descrição completa no extrato é fornecida ao banco ou na bandeira de cartão que processa o pagamento. Somente os primeiros 22 caracteres da descrição completa no extrato são enviados para pagamentos com cartão.
O extrato do cliente usa o componente estático da conta da plataforma para os seguintes tipos de cobrança
- Cobranças de destino sem
on_
behalf_ of - Cobranças e transferências separadas sem
on_
behalf_ of
O extrato do cliente usa o componente estático da conta conectada para os seguintes tipos de cobrança
- Cobranças diretas
- Cobranças de destino com
on_
behalf_ of - Cobranças e transferências separadas com
on_
behalf_ of
O uso do componente estático de uma conta conectada exige que a conta tenha a função card_payments.
Cuidado
Para versões da API 2019-02-19
e posteriores, o parâmetro statement_
de /v1/charges
é tratado como o componente dinâmico e é equivalente a fornecer statement_
.
Se statement_
e statement_
forem fornecidos, somente statement_
será utilizado.
Para versões da API anteriores a 2019-02-19
, os parâmetros de descrição no extrato em /v1/charges
são ignorados e a descrição no extrato estática da plataforma é utilizada.
Junto com uma descrição no extrato, outras informações sobre a empresa são enviadas para exibição no extrato do cliente (por exemplo, endereço, e-mail, telefone e URL). As informações adicionais são definidas como padrão como propriedades de suporte do business_profile da conta. Se um campo de suporte não for informado, o campo de suporte da plataforma será usado. Se o campo de suporte da plataforma não estiver disponível, os dados de identificação da conta serão fornecidos.
Comportamentos on_behalf_of
Para cobranças com on_
definidos, a descrição no extrato e os dados comerciais são primeiramente consultados na conta especificada. Se esses dados não forem definidos, os dados da plataforma serão utilizados.
- Se a cobrança tiver um componente dinâmico, o componente estático de configurações.card_payments.statement_descriptor_prefix da conta conectada será utilizado. Se a conta conectada não tiver um prefixo de descrição no extrato definido, o prefixo da descrição no extrato da plataforma será utilizado.
- Se os dados do perfil comercial da conta conectada não estiverem definidos, os dados da plataforma serão usados (primeiro o perfil comercial da plataforma e depois os dados de identificação da plataforma). Por exemplo, se a conta conectada não tiver um
support_
definido, ophone support_
da plataforma ou o número de telefone da identidade será informado.phone
Se você usa um sufixo dinâmico em uma cobrança que utiliza a descrição estática da conta conectada, recomendamos definir um prefixo para na conta conectada para que a descrição completa no extrato seja exibida corretamente.
O prefixo estático deve conter entre 2 e 10 caracteres. As bandeiras de cartão recebem apenas os 22 primeiros caracteres (incluindo o símbolo *
e o espaço que concatena o prefixo estático e o sufixo dinâmico) da descrição completa no extrato.
Defina statement_
e statement_
para ter flexibilidade na configuração de descrições no extrato em cobranças.
Quando a descrição no extrato é definida em cobranças com cartão e nenhum prefixo é definido, a Stripe trunca a descrição no extrato da conta para definir o valor do prefixo.
Definir um sufixo dinâmico para cobranças de contas conectadas
Os sufixos dinâmicos são aceitos apenas para cobranças em cartão utilizando o parâmetro statement_
. Leia mais sobre sufixos dinâmicos ou veja as descrições de extrato concatenadas (prefixo* sufixo) no Dashboard.
Definir descrições no extrato em japonês
Recomendamos definir os componentes estáticos das descrições no extrato em kanji e kana para contas conectadas japonesas. Você pode definir todas as descrições e os prefixos correspondentes ao criar uma conta conectada japonesa:
Você pode definir sufixos dinâmicos em kanji e kana quando criar cobranças de cartão com payment_
e payment_
.
Consulte Descrições no extrato em japonês para obter mais informações.