Intra Pay Brazilian PaymentsInstall

Summary

Send a Pix cash out payment using a recipient's Pix key and associated account and owner details.

Inputs

• Key (required) — The Pix key identifying the payment recipient.
• Key Type (required) — The type of Pix key (EVP, CPF, CNPJ, EMAIL, or PHONE). Defaults to EVP.
• End To End ID — A unique identifier for the payment transaction.
• Account Participant — The participant identifier for the recipient's account.
• Account Branch — The branch number of the recipient's account.
• Account Number — The number of the recipient's account.
• Owner Name — The name of the account owner.
• Owner Type — The type of the owner, either NATURAL_PERSON or LEGAL_PERSON. Defaults to NATURAL_PERSON.
• Owner Trade Name — The trade name of the account owner.
• Owner Document — The document number of the account owner.

Output shape

A single JSON object describing the payment result or status.

The output contains the API response to the payByKey cash out request as a JSON object. Errors are thrown as NodeApiError with message details.

Examples

Example 1: Typical payment by Pix key

Set the 'Key' to the recipient's Pix key, choose the appropriate 'Key Type', optionally provide 'End To End ID', recipient account details (participant, branch, number), and owner information (name, type, trade name, document number) to execute the payment.