Cash In

💰 What is Cash In with Static QR Code?

Cash In is a feature that allows you to add money (credit) to your virtual account via PIX. The operation is performed using a Static QR Code, which you can generate directly through the system.

This QR Code can be scanned using any banking app or digital wallet that supports PIX. Once scanned and paid, the amount is automatically credited to the linked virtual account.


🧾 How it works technically (simplified view):

When the system needs to generate a new QR Code for a PIX deposit, it sends a POST operation request to the following API endpoint:

https://api.aurixpay.ws/banking/v1/cashin/pix/qrcode/static

Information sent in the request body:

  • amount: value in cents (e.g., 1000 = R$10.00)

  • reference: a unique identifier for internal control (e.g., order number)

  • bank_account_id: ID of the linked bank account

  • currency: currency code (usually "BRL" for Brazilian Reais)

  • virtual_account_id: ID of the virtual account that will receive the funds

Example:

{
  "amount": 1000,
  "reference": "PED-2025-001234",
  "bank_account_id": "0197676a-012d-725c-95fa-b9a54a4536b1",
  "currency": "BRL",
  "virtual_account_id": "0197676a-013e-7121-b1a5-e720b44c5c95"
}

✅ What the system returns:

If everything goes well, the system responds with:

  • txid: the unique transaction identifier

  • qrcode: base64 image of the QR Code (can be rendered for the user to scan)

  • brcode: the PIX code (can be copied and pasted into a banking app)

  • expires_at: expiration date of the QR Code

Example response:

{
  "txid": "f13733b4-673b-4411-ba9d-e3029a94d1d6",
  "qrcode": "data:image/png;base64,...",
  "brcode": "00020126...6304C732",
  "expires_at": "2025-06-13T06:21:28.000000Z"
}

🛠️ What is it used for in the system?

  • Allows the user to easily and quickly add funds, with no fees.

  • Ideal for integrations with marketplaces, digital wallets, or financial apps that work with virtual accounts.

  • Available 24/7, with no need for manual approval.

Last updated