ZapGate icon

ZapGate

Interaja com a API ZapGate — WhatsApp gateway self-hosted

Actions1511

Histórico → Enviar Chave Pix

AI-generated

Summary

Send a Pix key card to a recipient

Inputs

  • to (required) — Recipient phone number with DDI (e.g., 5511999999999)
  • name (required) — Full name of the Pix key holder
  • key (required) — Pix key value (digits only, including DDI)
  • keyType (required) — Type of Pix key (PHONE, CPF, CNPJ, EMAIL, EVP)
  • instructions — Optional additional instructions shown in the card

Output shape

a single JSON object representing the created Pix key message

On success the response includes the message ID and status; errors are thrown and not returned unless continueOnFail is enabled.

Examples

Example 1: Send Pix key to a customer

resource=message, operation=sendPixKey, fields: to=5511999999999, name=Bruno Xavier Ondrusch, key=61995768696, keyType=PHONE, instructions=Pagamento de fatura

Example 2: Send Pix key via email type

resource=message, operation=sendPixKey, fields: to=5511999999999, name=Empresa XYZ, key=bruno@empresa.com, keyType=EMAIL, instructions=Assinatura de contrato

Links

Discussion