Adicionar conta bancária

Crie uma nova conta bancária para a empresa.

A criação de uma conta bancária é essencial para realizar saques dos valores recebidos através da Super Pagamentos.

Importante: A conta bancária deve obrigatoriamente pertencer ao mesmo titular/CNPJ da conta na Super Pagamentos. Contas bancárias de terceiros não são aceitas por questões de segurança e conformidade.

Tipos de conta aceitos:

• Conta Corrente
• Conta Poupança

Documentação necessária:

• A conta bancária deve estar no mesmo nome/CNPJ cadastrado na Super Pagamentos
• Todos os dados bancários devem estar corretos e atualizados

Operação em subconta: Para criar uma conta bancária em uma subconta específica, inclua o header x-subaccount-id com o ID da subconta. Quando este header é fornecido, a operação será realizada no contexto da subconta especificada, em vez da conta principal autenticada.

POST /bank_accounts

cURL

cURL

curl --request POST \
  --url https://sandbox-api.superpagamentos.com/bank_accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "holderName": "EMPRESA EXEMPLO LTDA",
  "bankCode": "001",
  "routingNumber": "1234-0",
  "accountNumber": "123456-78",
  "accountType": "SAVINGS",
  "document": "12345678901"
}
'

200

Example

{
  "data": {
    "holderName": "Empresa Teste LTDA",
    "bankCode": "001",
    "routingNumber": "0001-00",
    "accountNumber": "12345678-00",
    "document": "00000000000",
    "accountType": "CHECKING",
    "status": "APPROVED"
  },
  "message": "Conta bancária criada com sucesso"
}

Authorizations

Authorization · string · header · required

Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer

Headers

x-subaccount-id · string<uuid>

ID da subconta onde a operação será realizada. Quando fornecido, a operação será executada no contexto desta subconta específica.

Body

application/json

Dados necessários para criação de uma conta bancária

holderName · string · required

Nome do benefíciario da conta

Example:

"EMPRESA EXEMPLO LTDA"

bankCode · string · required

Código do banco

Example:

"001"

routingNumber · string · required

Número da agência com dígito verificador.Se não possuir DV, coloque 0 após o hífen

Example:

"1234-0"

accountNumber · string · required

Número da conta com dígito verificador. Se não possuir DV, coloque 0 após o hífen

Example:

"123456-78"

accountType · enum<string> · required

Tipo da conta bancária

Available options: SAVINGS, CHECKING

Example:

"SAVINGS"

document · string · required

CPF ou CNPJ do benefíciario da conta

Example:

"12345678901"

Response

200

application/json

Conta bancária criada com sucesso

data · object

Show child attributes

message · string

Example:

"Conta bancária criada com sucesso"