Intra Pay Brazilian PaymentsInstall

Summary

Process a PIX cash out payment by specifying the recipient's account details and payment information.

Inputs

• Account (required) — The recipient's account number to which the PIX payment will be sent.
• Branch (required) — The branch (agency) number of the recipient's bank account.
• Bank (ISPB) (required) — The ISPB code identifying the recipient's bank.
• Amount (required) — The amount to be paid via PIX.
• Tax ID (required) — The tax identification number (e.g., CPF or CNPJ) of the recipient.
• Name (required) — The full name of the recipient.
• Account Type (required) — The type of the recipient bank account (options: CACC, TRAN, SLRY, SVGS). Defaults to CACC.
• Description (required) — A description or memo for the payment.
• Password (required) — The password for authorizing the PIX cash out operation.

Output shape

a single JSON object containing the API response of the PIX cash out payment request

The output JSON includes details returned by the Intra Pay API upon successful payment initiation. Errors during the operation are returned as node errors.

Examples

Example 1: Send a PIX payment to a recipient's bank account

Set the Account, Branch, Bank (ISPB), Amount, Tax ID, Name, Account Type (e.g., 'CACC'), Description, and Password parameters to initiate the payment.