Intro to PAYELU APIs

Bite sized, Actionable, Tips and Tricks and API References

Introduction to PAYELU APIs

Welcome to PAYELU, a modern FinTech Payment Service Provider (PSP) designed to simplify and enhance the payment processing experience for merchants. Our APIs empower businesses with fast, secure, and scalable solutions for handling bank transfers and real-time payment methods, tailored to specific markets across Argentina, Peru, Brazil, Paraguay, and Uruguay.
Our innovative platform provides merchants with flexible integration options to meet a variety of business needs, ensuring seamless payment flows and compliance with local payment infrastructures. Whether you're working with standard bank transfers or PIX real-time payments in Brazil, PAYELU offers the tools you need to succeed.

Capabilities

PAYELU's APIs enable merchants to unlock a variety of payment processing and payout features:
  • Bank Transfers: Easily process and reconcile payments with direct bank transfers in local currencies for supported countries.
  • PIX Integration in Brazil: Leverage the power of Brazil's instant payment system to facilitate real-time transactions with low fees.
  • Secure Payouts: Manage disbursements and payouts to customers or partners through structured workflows and secure processes.
  • Multi-Currency Support: Operate seamlessly across multiple countries while maintaining control of currency-specific balances.
  • Advanced Authentication: Protect your transactions with robust authentication methods, including HMAC-based hash validation for API security.

Where to Begin?

Understand the Services

To start using PAYELU's APIs, it's important to identify which services your business needs. For example:
  • Bank Transfers: A reliable option for businesses operating in Argentina, Peru, Paraguay, and Uruguay.
  • PIX in Brazil: Ideal for businesses in Brazil that require instant payment capabilities.
  • Payouts: Perfect for businesses handling vendor or customer disbursements.
Detailed information about the transaction flows and technical examples for each service can be found in the Services section of this documentation.

Explore the API

Each API method is thoroughly documented in the API Reference section, including request and response structures, error handling, and real-world examples.

Testing Your Integration

Once you're ready to integrate, you'll receive API credentials to access the test environment, which allows you to simulate transactions without affecting real accounts. Please note that some methods may not have a test mode available. In such cases, you'll receive credentials to work directly in production mode.

API Credentials

To begin using PAYELU APIs, you will need the following credentials:
Name
Description
Example
api_url
Base URL for API requests
https://api.payelu.com
auth_point_id
Unique identifier for your merchant account in PAYELU
502034de-48e4-44eb-a437-2bc7773964f7
service_id
Unique identifier for the payment service (e.g., bank transfers, PIX, payouts)
1234
auth_api_token
Shared secret string used for API authentication
AtHhxl0NMIOmMMb2l2ToPf2lfurWDyM32Me26sWPJMF
unique_key
A unique random number (provided by you) used to enhance security during API requests
1234567890
hash
A HMAC-SHA256 hash generated using auth_api_token, auth_point_id, and unique_key for authentication
20298ff4f75f6925befd35ec706e09b693f06325c81852defcb20d6a0d456bf7
After completing your testing, PAYELU will provide you with new credentials for production mode, including:
  • A new auth_point_id
  • Production-specific service_id values
  • Updated auth_api_token for live transactions
Your test credentials will remain active, enabling you to continue using the sandbox environment for future development and testing.

Support and Resources

During the integration process, our technical support team is available to assist you with any questions or challenges. Our documentation is regularly updated to include solutions to frequently asked questions from our merchants.
We look forward to supporting your business as you integrate PAYELU APIs and begin processing payments with confidence. Let's build something extraordinary together!