Welcome

Welcome to the Rumbapay Payments API!

Our API enables you to accept and process payments across multiple methods with global coverage. This documentation will guide you through:

1. Getting Started

   • Authentication

   • Signature

2. Payment Methods

   • Argentina – Bank Transfer

     • Payment

     • Payout

   • Brazil – PIX

     • Payment

     • Payout

   • Bank transfer Mexico

     • Payment

     • Payout

   • Cash Mexico

     • Payment

   • Cash Chile

     • Payment

Authentication & Security

All API requests must include an access-token header generated via HMACSHA256 using your merchant key and login, and a signature header on every request and response to ensure payload integrity.

Payment & Payout Workflows

• Argentina (bank_transfer_argentina)

  • Payment: Supports both server-to-server (H2H) and hosted payment page (HPP) flows, determined by challenge.challenge_type in the response.

  • Payout: Use the Payout API (/v1/payout) to send funds directly to customer bank accounts.

• Brazil (PIX)

  • Payment: Returns either a QR code string (challenge.challenge_qr.code) for in-app scanning or a redirect URL (challenge.challenge_redirect.url).

  • Payout: Send funds instantly to a PIX account using the payout endpoint.

• Chile (cash)

  • Payment: Supports hosted payment page (HPP) flow

• Mexico (cash, bank_transfer_mexico)

  • Payment: Supports hosted payment page (HPP) flow for methods cachand bank_transfer_mexico

  • Payout: Use the Payout API (/v1/payout) to send funds directly to customer bank accounts

Next Steps

1. Obtain your merchant login and key from the Rumbapay dashboard.

2. Review the Authentication and Signature guides to secure your integration.

3. Choose your payment method and follow the detailed flow.

4. Monitor transactions via the Check Payment Status endpoint and handle callbacks to stay updated on payment outcomes.

Let's get started 🚀