Abertura de conta

Este endpoint possibilita que parceiro solicite a criação de uma conta de pagamentos ou conta corrente para um cliente pessoa física.

Depois que a conta é criada, o cliente passa a ser reconhecido no sistema financeiro como um titular de uma conta (de pagamentos ou corrente) e poderá realizar operações, como transações via Pix, TED, emissão de boletos, depósitos via boletos, pagamento de contas (boletos e convênios), dentre outras operações financeiras.

Adicionalmente o cliente poderá ter um cartão de crédito pré-pago vinculado à sua conta.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

• O cliente tenha tido seu registro aprovado.

🚧

Importante

A conclusão do registro é confirmada por meio do evento ACCOUNT_HOLDER_WAS_CREATED.

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/customers/{{documentNumber}}/accounts

--request POST 
--url 'https://api-mtls.sandbox.bankly.com.br/customers/{{documentNumber}}/accounts' \
--header 'api-version: 1.0' \
--header 'Authorization: Bearer {{Token}}' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key : {{uuid v4}}' \
--data-raw '{
	"accountType": "PAYMENT_ACCOUNT 
}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.

Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

🚧

Importante

Caso o cliente possua multicontas ativas, o parceiro deverá utilizar o cabeçalho Idempotency-Key nas requisições, a fim de evitar a criação de contas duplicadas.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

{
	"accountType": "PAYMENT_ACCOUNT"
}

Resposta (Response)

O status code 201 indicará que a conta foi criada com sucesso.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{
    "balance": {
        "inProcess": {
            "amount": 0.0,
            "currency": "BRL"
        },
        "available": {
            "amount": 0.0,
            "currency": "BRL"
        },
        "blocked": {
            "amount": 0.0,
            "currency": "BRL"
        }
    },
    "status": "ACTIVE",
    "branch": "2020",
    "number": "502000027888"
}

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são: