Realizar uma Transferência via TED

Essa funcionalidade permite que os clientes da Celcoin consigam efetuar transferências TED para instituições financeira

📘
Restrições de horário
Dias da semana: A funcionalidade de TED estará disponível exclusivamente de segunda a sexta-feira.
Horário de início: A partir das 06:30 (horário local).
Horário de término: Até as 17:00 (horário local).
Obs: A Limitação funciona apenas em produção, em sandbox o ambiente funciona 24/7 pois utilizamos dados mockados para simular os cashout

Passos para Integrar

Realizar autenticação na API - [API Reference]
Realizar uma transferência TED - [API Reference]
Receber o Webhook com Status do TED

Caso seja necessário você pode consultar o status do TED manualmente.

Consultar Status do TED - [API Reference]

Descrição dos campos

Campo	Descrição	Tipo Campo
amount	Valor da transação.
clientCode	Identificador único da transação gerado pelo cliente.
account	Número da conta de origem (Quem irá pagar).
bank	Identificador do Banco de destino (ISPB - Identificador de Sistema de Pagamentos Brasileiro).
account	Número da Conta de destino (Quem irá receber).
branch	Número da agência de destino.
taxId	Número do documento (CPF ou CNPJ) da conta de destino.
name	Nome da conta de destino
accountType	Tipo de Conta.	CC* - Conta Corrente CI* - Conta Investimento PG - Conta de Pagamento PP **- Conta Poupança
personType	Tipo de Pessoa.	F* - Fisica J* - juridica
clientFinality	Finalidade	1 - Pagamento de Impostos, Tributos e Taxas 3** - Pagamentos de Dividendos 4 - Pagamento de Salários 5** - Pagamento de Fornecedores 7 - Pagamento de Aluguéis e Taxas de Condomínio 9 *- Pagamento de Mensalidade Escolar 10 *- Crédito em Conta 100 *- Depósito Judicial 110 *- Transferência entre contas de mesma titularidade 99999 **- Outros
description	Campo opcional. Caso o campo clientFinality estiver como 99999, este campo vai se tornar obrigatório.

📘
Importante
Para realizar o envio de uma TED com sucesso no ambiente de sandbox, é necessário preencher o campo 'bank' com qualquer ISPB válido (exceto 13935893, que corresponde à Celcoin) e o campo 'account' com '000001', ambos no objeto 'creditParty'.

⚠️
Atenção
O dígito verificador deve ser enviado junto ao número da conta. Em caso de agência com dígito verificador, este deve ser removido.

JSON de exemplo

{
   "amount":0.01,
   "clientCode":"ad575298-8e81-4f90-a0b0-f3a04d8a48c6",
   "debitParty":{
      "account":"30023646056255"
   },
   "creditParty":{
      "bank":"30306294",
      "account":"000001",
      "branch":"20",
      "taxId":"09958359006",
      "name":"Joao Silva Santos",
      "accountType":"CC",
      "personType":"J"
   },
   "clientFinality":"110",
   "description":""
}

cURL da chamada

curl --location 'https://sandbox.openfinance.celcoin.dev/baas/v2/spb/transfer' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{Token}}' \
--data '{
    "amount": 0.01,
    "clientCode": "ad575298-8e81-4f90-a0b0-f3a04d8a48c6",
    "debitParty": {
        "account": "30023646056255"
    },
    "creditParty": {
        "bank": "30306294",
        "account": "000001",
        "branch": "20",
        "taxId": "09958359006",
        "name": "Joao Silva Santos",
        "accountType": "CC",
        "personType": "J"
    },
     "clientFinality": "110"
}'

Exemplo de retorno

👍
Sucesso 200

{
  "status": "PROCESSING",
  "version": "1.0.0",
  "body": {
    "id": "34fee7bc-4d40-4605-9af8-398ed7d0d6b5",
    "amount": 0,
    "clientCode": "1458854",
    "debitParty": {
      "account": "444444",
      "branch": "1",
      "taxId": "11122233344",
      "name": "Celcoin",
      "accountType": "CACC",
      "personType": "F",
      "bank": "30306294"
    },
    "creditParty": {
      "bank": "30306294",
      "account": "10545584",
      "branch": "1",
      "taxId": "11122233344",
      "name": "Celcoin",
      "accountType": "CC",
      "personType": "F"
    }
  }
}

❗
Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "CIE999",
    "message": "Ocorreu um erro interno durante a chamada da api."
  }
}

Tabela de errorCode

Code	Message
CBE001	ClientCode é obrigatório.
CBE093	ClientCode possui tamanho maximo de 200 caracteres.
CBE094	amount é obrigatório.
CBE095	amount invalido.Favor verificar a formatação do campo e deve ser maior que 0.
CBE100	Existe um lançamento idêntico pendente.Favor aguarde para realizar esta operação para evitar duplicidade.
CBE101	Já existe um lançamento com o mesmo clientCode. Favor realizar uma nova operação.
CBE102	Lançamento de debito não permitido.Valor ultrapassa o limite maximo permitido por operação.
CBE107	debitParty é obrigatório.
CBE108	debitparty.account é obrigatório.
CBE109	debitparty.account invalido.
CBE110	debitparty.account possui tamanho maximo de 20 caracteres.
CBE115	creditParty é obrigatório.
CBE116	creditparty.account é obrigatório.
CBE117	creditparty.account invalido.
CBE118	creditparty.account possui tamanho maximo de 20 caracteres.
CBE119	creditParty.branch é obrigatório.
CBE120	creditParty.branch invalido.
CBE121	creditParty.taxId é obrigatório.
CBE122	creditParty.taxId invalido.
CBE123	Transação não permitida.Conta com saldo insuficiente.
CBE124	Lançamento não permitido.debit.account esta encerrada.
CBE126	creditParty.bank é obrigatório e deve existir na lista de participantes Pix.
CBE127	creditParty.name é obrigatório e possui tamanho maximo de 120 caracteres.
CBE128	creditParty.accountType não foi informado ou é invalido.
CBE159	Lançamento não permitido.Sua conta esta bloqueada.
CBE269	creditParty.personType não foi informado ou é invalido.
CBE270	clientFinality não foi informado ou é invalido.
CBE271	Campo description obrigatorio quando o campo clientFinality estiver preenchido com 99999 (Outros).
CBE272	É necessário informar pelo menos um dos campos: id ou clientCode.
CBE274	Não é permitido enviar TED para a mesma conta sendo do mesmo Participante.
CBE275	Não é permitido TED para outra titularidade.

Updated 6 days ago