Skip to main content

​
Transferências (Pix Out)

Exemplos de uso do client.transfers para operações de cash-out via Pix.
O método client.transfers.create chama a API de Pix Out para criar transferências (cash-out). Essa API exige um IP fixo e seguro de origem para as requisições; chamadas originadas de IPs desconhecidos ou não autorizados serão bloqueadas.
Pix Out para qualquer chave Pix é uma funcionalidade de Banking as a Service (BaaS) e precisa ser habilitada explicitamente. Por padrão, sua conta só está autorizada a solicitar transferências Pix Out para a própria chave Pix.

​
Criar transferência Pix Out

const transfer = await client.transfers.create({
	pix_key_type: "CPF",
	pix_key_value: "12345678901",
	amount: 5000, // R$50,00 em centavos
	description: "Pagamento fornecedor",
	external_ref: "pedido-001",
});

console.log(transfer.data.id, transfer.data.status);

​
Listar transferências

const page = await client.transfers.list({ page: 1, limit: 20, status: "pending" });

console.log(page.data.metadata.total);
console.log(page.data.data.length);

​
Consultar transferência

const tf = await client.transfers.retrieve("id-da-transferencia");
console.log(tf.data.status, tf.data.amount);

​
Cancelar transferência

const cancelled = await client.transfers.cancel("id-da-transferencia", {
	reason: "Destinatario incorreto",
});

console.log(cancelled.data.status);

​
Iterar automaticamente por todas as transferências

for await (const tf of client.transfers.listAutoPagingIterator({ limit: 100 })) {
	console.log(tf.id);
}