Abertura de conta
stable scope: account.create
Após a aprovação do cadastro do cliente, o parceiro poderá solicitar a criação de uma conta de pagamentos.
Endpoint
Para o uso deste endpoint, é preciso preencher os seguintes campos:
documentNumber
: número do documento CPF do cliente. Informe somente os números;Idempotency-Key
: informação utilizada para evitar a duplicidade de transações (valor em formato UUID);accountType
: tipo de conta, neste caso "PAYMENT_ACCOUNT".
curl --location --request POST 'https://api-mtls.sandbox.bankly.com.br/customers/{{documentNumber}}/accounts' \
--header 'api-version: 1' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key : {{uuid v4}}'
--data-raw '{
"accountType": "PAYMENT_ACCOUNT"
}'
Depois que a conta é criada, o cliente passa a ser reconhecido no sistema financeiro como um titular de conta de pagamentos 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.
Importante
Considere o uso do cabeçalho de requisição
Idempotency-Key
, afim de evitar operações duplicadas.
Adicionalmente o cliente poderá ter um cartão de crédito pré-pago vinculado à sua conta.
Retorno
O retorno 201 indicará que a conta de pagamento foi criada com sucesso.
Status code | Código | Descrição |
---|---|---|
409 | HOLDER_ALREADY_HAVE_A_ACCOUNT | Não é possível criar mais de uma conta por documento. |
422 | ACCOUNT_HOLDER_NOT_EXISTS | Conta não existente ou o registro do cliente ainda não foi aprovado. |
Updated 11 months ago