Skip to main content
POST
Incluir a conta de recebimento
Inclui ou substitui a conta onde o cliente recebe o crédito. Só para propostas de refinanciamento, enquanto a etapa ativa for CONTA_RECEBIMENTO. Exemplo:
O cpfTitular precisa ser o CPF do cliente da proposta. Senão, a API retorna Proposal.DepositAccount.HolderNotBuyer.
codigoBanco com 3 dígitos, agencia com até 4 dígitos, conta de 4 a 13 dígitos. digitoAgencia e digitoConta são obrigatórios: um único caractere, de 0 a 9 ou X. tipoConta: CORRENTE, POUPANCA ou PAGAMENTO.
Enviar de novo substitui a conta anterior, enquanto a etapa estiver ativa.
Retorna 204 No Content. A etapa CONTA_RECEBIMENTO é do comprador. Fora dela, a API retorna 422 com Proposal.ProposalIsNotInDepositAccountStatus.

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Path Parameters

propostaId
string<uuid>
required

Identificador único da proposta (UUID) retornado na criação da proposta

Example:

"bea8d060-f93d-48eb-b6c4-45f64483cdd9"

Body

application/json
cpfTitular
string
required

CPF do titular da conta, formatado ou apenas números. Deve ser o CPF do cliente da proposta.

Example:

"12345678909"

codigoBanco
string
required

Código do banco (COMPE) com 3 dígitos.

Example:

"001"

agencia
string
required

Número da agência com até 4 dígitos, sem o dígito verificador.

Example:

"1234"

digitoAgencia
string
required

Dígito verificador da agência (número ou X).

Example:

"5"

conta
string
required

Número da conta, de 4 a 13 dígitos, sem o dígito verificador.

Example:

"123456"

digitoConta
string
required

Dígito verificador da conta (número ou X).

Example:

"7"

tipoConta
enum<string>
required

Tipo da conta.

Available options:
CORRENTE,
POUPANCA,
PAGAMENTO
Example:

"CORRENTE"

Response

Conta de recebimento registrada. A resposta não tem corpo.

Resposta sem corpo