Quais são os campos obrigatórios no Pix Cash-out?

A Celcoin suporta quatro modalidades de envio de Pix. Embora todas exijam campos básicos como amount (valor) e clientCode (seu identificador único), o objeto de destino (creditParty) muda conforme a modalidade:

Iniciação via Chave Pix (initiationType: DICT)

É a forma mais simples. Você informa apenas a chave cadastrada pelo recebedor.

• Campos principais: key (CPF, CNPJ, E-mail, Telefone ou Chave Aleatória).

Iniciação Manual (initiationType: MANUAL)

Utilizada quando o recebedor não tem chave ou você prefere usar os dados da conta (como em uma TED).

• Campos principais: name, taxNumber (CPF/CNPJ), bank (ISPB do banco), accountNumber e accountType (CC ou Poupança).

Iniciação via QR Code Estático (initiationType: STATIC_QR_CODE)

Para pagamentos de balcão ou transferências recorrentes sem valor fixo.

• Campos principais: qrCode (a string lida do código).

Iniciação via QR Code Dinâmico (initiationType: DYNAMIC_QR_CODE)

Utilizada para automação de cobranças, e-commerce ou tributos (como o FGTS Digital).

• Campos principais: qrCode (string completa do payload da cobrança).
   

📋 Checklist de campos comuns (Presentes em todas as APIs)

Além dos dados do recebedor, toda requisição de Cash-out deve conter:

• amount: Valor da transação.

• transactionIdentifier: Identificador que aparecerá no extrato do recebedor (E2E ID).

• clientCode: Seu código interno para controle e prevenção de duplicidade.

• description: (Opcional) Texto que o recebedor lerá no extrato.
   

Por que essa estrutura é importante?

Preencher os campos corretamente de acordo com a modalidade evita erros de validação (CBE004 - Bad Request) e garante que a transação seja processada instantaneamente pelo Banco Central.

🔗 Dica técnica: Para entender as regras de cada campo, consulte o detalhamento em: Documentação Pix Cash-out Celcoin.