Realizar pagamento PIX (Cash-Out)
Envia um pagamento PIX para uma chave PIX de destino. A transação é criada com status PENDING e o resultado final é notificado via webhook ou pode ser consultado via polling .
Requer token Bearer no header Authorization.
Campo Tipo Obrigatório Descrição valuenumber Sim Valor em reais (até 2 casas decimais). Mínimo: 0.01 externalIdstring Sim Identificador externo único por conta. Máximo: 50 caracteres descriptionstring Não Descrição da transação. Máximo: 140 caracteres detailsobject Sim Informações da chave PIX de destino details.keystring Sim Chave PIX de destino (veja formatos abaixo) details.keyTypestring Sim Tipo da chave: DOCUMENT, EMAIL, PHONE, RANDOM. Obrigatório pois a API não consulta DICT details.namestring Sim Nome do destinatário (informativo, máx. 100 caracteres) details.documentstring Sim CPF (11 dígitos) ou CNPJ (14 dígitos) do titular. Obrigatório para todos os keyTypes
keyTypeFormato Exemplo DOCUMENTCPF: 11 dígitos / CNPJ: 14 dígitos (apenas números) 12312312387, 12345678000195EMAILEndereço de email válido usuario@exemplo.comPHONEDDD + número (10-11 dígitos, sem DDI +55) 11999999999RANDOMUUID (com ou sem hífens) a1b2c3d4-e5f6-4890-abcd-ef1234567890
{ "value" : 15.50 , "externalId" : "external-teste-001" , "description" : "Pagamento fornecedor XYZ" , "details" : { "key" : "12312312387" , "keyType" : "DOCUMENT" , "name" : "John Marvin" , "document" : "12312312387" } } Campo Tipo Descrição transactionIdstring Identificador interno da transação gerada (UUID) externalIdstring Identificador externo informado na requisição statusstring Status inicial: PENDING. Confirmação via webhook: CONFIRMED ou ERROR generateTimestring Data/hora de geração da transação (ISO 8601 UTC)
{ "transactionId" : "8b3b85ac-394c-4144-9bcb-c5d12de3fa56" , "externalId" : "external-teste-001" , "status" : "PENDING" , "generateTime" : "2024-01-15T10:30:00.000Z" } Status Descrição 400 Dados inválidos, saldo insuficiente ou limite excedido 401 Token não fornecido ou inválido 409 externalId já utilizado para esta conta500 Erro interno ao processar pagamento
Código Descrição DUPLICATE_EXTERNAL_IDO externalId já foi utilizado para esta conta INSUFFICIENT_BALANCESaldo insuficiente (valor + taxa) TRANSACTION_LIMIT_EXCEEDEDValor excede o limite por transação DAILY_LIMIT_EXCEEDEDAcumulado do dia excede o limite diário NIGHT_LIMIT_EXCEEDEDOperação noturna excede o limite reduzido (20h–6h) INVALID_AMOUNTValor menor que 0.01 ou com mais de 2 casas decimais INVALID_PIX_KEYFormato da chave não corresponde ao keyType informado
Quando o banco liquidante rejeita a operação, a transação muda para ERROR e os campos errorCode / errorMessage são enviados no webhook de Cash-Out :
errorCodeDescrição Retentável? TAX_ID_MISMATCHO details.document não corresponde ao titular da chave PIX Não INVALID_TAX_IDCPF/CNPJ inválido Não BLOCKED_ACCOUNTConta de destino bloqueada Não ACCOUNT_CLOSEDConta de destino encerrada Não ORDER_REJECTEDBanco de destino rejeitou a operação Não PAYMENT_EXPIREDTransação expirou antes de ser processada Sim SETTLEMENT_TIMEOUTBanco de destino não respondeu a tempo Sim
