Instalar/Configurar Módulo Transferências Automáticas
PUT /pix/automatic-transfers
Para utilizar esse método, o access_token deve conter o scope company.write
Permite instalar/configurar o módulo de transferências automáticas dos tipos manual/Pix, para mesma titularidade. As transferências são realizadas via Pix todos os dias úteis às 12h.
URL da Requisição
https://api.sandbox.cel.cash/v2/pix/automatic-transfers
Body da requisição
Código da resposta
---
Tempo de resposta
---
Body da Resposta
{
"type": true,
"Config": {
"minValueAccount": 1,
"type": "key",
"createdAt": "2020-06-02 10:10:00",
"updatedAt": "2020-06-02 10:10:00",
"Key": {
"type": "cpf",
"value": "28933357050"
},
"ManualInfo": {
"ispb": "18236120",
"agency": "0001",
"number": "321587559",
"type": "current",
"document": "91887459000104",
"name": "Lorem Ipsum"
}
}
}
Nome
Tipo
Explicação
type
bool
Módulo instalado com sucesso.
Config
Informações da configuração do módulo.
Clique para ver os campos.
Clique para ver os campos.
minValueAccount
int 11 dígitos
Valor mínimo do saldo na conta (o valor deverá ser informado em centavos).
type
string 255 caracteres
Tipo de transferência que deseja utilizar.
Valor
Explicação
manual
Dados manuais (Agência e Conta)
key
Chave Pix
createdAt
datetime
Data de criação.
updatedAt
datetime
Data de alteração.
Key
Informações para realizar a transferência automática do tipo key.
Clique para ver os campos.
Clique para ver os campos.
type
string 255 caracteres
Tipo da chave Pix
Valor
Explicação
cpf
Documento: CPF
cnpj
Documento: CNPJ
email
E-mail
mobilePhone
Celular
random
Chave Aleatória (EVP)
value
string 255 caracteres
Chave Pix.
ManualInfo
Informações para realizar a transferência automática do tipo manual.
Clique para ver os campos.
Clique para ver os campos.
ispb
string 8 caracteres
Identificador de Sistema de Pagamentos Brasileiro.
agency
string 4 caracteres
Número da agência.
number
string 255 caracteres
Número da conta.
type
string 255 caracteres
Tipo da conta.
Valor
Explicação
current
Corrente
salary
Salário
savings
Poupança
transactional
Transacional
document
string 14 caracteres
CPF ou CNPJ do cliente, cadastrado na conta para o saque (tem que ser o mesmo da conta cel_cash). Apenas números.
name
string 255 caracteres
Nome cadastrado na conta.
error
Nó de erros, caso haja.
Clique para ver os campos.
Clique para ver os campos.
message
string 255 caracteres
Mensagem que indica qual o erro.
details
Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.
Clique para ver os campos.
Entity.field
array de string
Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.
Código
Explicação
200
Módulo instalado/Configurado com sucesso.
400
Erros de validação.
401
Falha ao autenticar.
403
Validação de segurança.