Contas, chaves e identificadores
Como a conta, a chave de API, a operação doméstica ou offshore e os identificadores accountId, número interno e accountNumber se relacionam, e qual usar em cada rota.
Cada credenciamento na Accelerazione cria uma conta, com uma chave de API por ambiente. A chave identifica a conta em toda chamada: por isso nenhuma rota pede o identificador da conta no corpo para saber quem está cobrando. Os outros identificadores desta página servem para apontar qual saldo, qual recebedor ou qual conta bancária você quer consultar ou movimentar dentro da sua conta.
Operação doméstica e offshore
Se você vende tanto no Brasil (BRL) quanto no exterior (USD), a operação doméstica e a offshore são credenciamentos separados. Cada um tem a sua própria chave de API, os seus recebedores, o seu escopo (Domestic ou Offshore) e a sua conta de saldo, no sandbox e em produção.
| Operação doméstica | Operação offshore | |
|---|---|---|
| Chave de API | Uma chave própria | Outra chave própria |
| Escopo da conta | Domestic | Offshore |
| Moeda típica | BRL | USD |
Conta de saldo (accountId) | Uma | Outra |
Use a chave de cada operação nas vendas daquela operação. O escopo da venda vem da chave que criou a cobrança.
O split não muda o escopo da venda
Incluir o recebedor da operação offshore no split de uma cobrança criada com a chave doméstica não transforma a venda em offshore: ela continua doméstica, com as regras e as condições comerciais da conta doméstica. Para vender como offshore, crie a cobrança com a chave offshore.
O escopo também precisa ser coerente na sessão 3DS: envie em transaction_scope o escopo da conta da chave que abre a sessão.
Os identificadores de uma conta
Três números diferentes podem aparecer quando você fala do dinheiro da sua conta. Eles não são intercambiáveis: cada rota aceita só o seu.
| Identificador | Formato | O que identifica | Onde usar |
|---|---|---|---|
accountId | UUID | A conta interna da Accelerazione que guarda o seu saldo. | Saldo e saques. |
| Número interno da conta | Número | A mesma conta interna, no razão contábil da Accelerazione. | Só em comunicação com a equipe de integração. Nenhuma rota recebe esse número. |
accountNumber | Número | Uma conta bancária no provedor, vinculada à sua conta. | Extrato bancário. |
O accountId e o número interno são entregues no credenciamento, um par por operação e por ambiente. O accountNumber existe só quando há uma conta bancária vinculada à sua conta no provedor.
Três consequências práticas:
- Saldo e extrato são consultas diferentes. O saldo mostra o que a Accelerazione registrou na sua conta interna, separado entre disponível, bloqueado e reservado. O extrato mostra as movimentações da conta bancária no provedor. Os valores dos dois não precisam coincidir.
- Ter
accountIdnão garante extrato. O credenciamento da conta interna não cria, sozinho, uma conta bancária vinculada. Sem esse vínculo, o extrato responde404 Statement.BankAccountNotFounde o saque não tem conta de origem para executar. - Não troque um número pelo outro. Enviar o número interno em
accountNumber, ou oaccountNumberemaccountId, resulta em404ou400, nunca em dados de outra conta.
Sandbox e produção
Os identificadores de sandbox e de produção são diferentes, assim como as chaves. Guarde-os em configuração por ambiente, junto com a chave, e nunca reaproveite um identificador de sandbox em produção.
O que pedir no credenciamento
Para cada operação (doméstica e, se houver, offshore) e para cada ambiente:
- A chave de API, com as permissões das rotas que você vai usar.
- Os
recipientIddos recebedores usados no split. - O
accountIdda conta de saldo, se você vai consultar saldo ou sacar. - O
accountNumberda conta bancária vinculada, se você vai consultar o extrato. - As origens HTTPS dos seus checkouts, para o 3DS.