Zendry API 1.0 icon

Zendry API 1.0

Integração com Zendry (Pix, Payments, Webhooks, Account, Crypto, Checkout)
Join our community

Actions20

Overview

This node integrates with the Zendry API to manage Pix payments, specifically allowing the creation of manual Pix payments. It is useful for automating payment processes where manual payment details need to be specified, such as paying a receiver by providing their bank details directly. For example, it can be used to create a payment to a receiver's bank account by specifying their name, document, bank ISPB, agency, account number, and account type, along with the payment amount and idempotent ID to ensure request uniqueness.

Use Case Examples

  1. Creating a manual Pix payment to a receiver's bank account by specifying all required receiver details and payment amount.
  2. Automating payment workflows in financial applications where manual Pix payments are needed.

Properties

Name Meaning
Idempotent ID A unique identifier to ensure the payment request is processed only once, preventing duplicate payments.
Value (cents) The amount to be paid, specified in cents. Must be at least 1 cent.
Authorize Automatically Boolean flag indicating whether the payment should be authorized automatically upon creation.
Receiver Name The name of the payment receiver.
Receiver Document The document number (e.g., CPF/CNPJ) of the payment receiver.
Receiver Bank ISPB The ISPB code of the receiver's bank.
Receiver Agency The agency number of the receiver's bank account.
Receiver Account The account number of the receiver's bank account.
Receiver Account Type The type of the receiver's bank account.

Output

JSON

  • json
    • id - Unique identifier of the created payment.
    • status - Current status of the payment.
    • value_cents - The payment amount in cents.
    • receiver_name - Name of the payment receiver.
    • receiver_document - Document number of the payment receiver.
    • receiver_bank_ispb - ISPB code of the receiver's bank.
    • receiver_agency - Agency number of the receiver's bank account.
    • receiver_account - Account number of the receiver's bank account.
    • receiver_account_type - Type of the receiver's bank account.
    • authorized - Indicates if the payment was authorized automatically.

Dependencies

  • Zendry API with API key credential

Troubleshooting

  • Ensure the 'Idempotent ID' is unique for each payment request to avoid duplicate payment errors.
  • The 'Value (cents)' must be a positive integer greater than zero; otherwise, the API will reject the request.
  • All required receiver details must be provided; missing fields like receiver name or bank details may cause the API to return validation errors.
  • If the API returns authentication errors, verify that the Zendry API credentials are correctly configured and valid.

Links

Discussion