BRL virtual accounts (Brazil)

Enabled on request. Pix accounts are in beta and are switched on per account. Ask Pagoramp to turn them on.


Country	Brazil
Payment rail	Pix (BR code)
Account types	dedicated
Customers	Individuals and businesses
When it is ready	The customer verifies first. Business customers also supply formation, source of funds and address documents. The account is ready once they are approved.

1. Check availability

Ask what BRL needs for your account. The answer lists the required fields per customer type and account type.

curl "https://pay-api.pagoramp.com/api/v1/virtual-accounts/availability?currency=BRL" \
  -H "x-api-key: YOUR_API_KEY"

2. Create the customer

Required for an individual: firstname, lastname, email. See Virtual account requirements for every combination.

curl -X POST https://pay-api.pagoramp.com/api/v1/customers \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"firstname":"Ada","lastname":"Okafor","email":"[email protected]"}'

The customer is created with kycStatus incomplete or pending. Anything missing for BRL can be added later with PATCH /customers/{uuid} before you request the account.

3. Request the account

curl -X POST https://pay-api.pagoramp.com/api/v1/virtual-accounts \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"224ca5c5-f2a6-419b-bf36-73997434d945","currency":"BRL","type":"dedicated","reference":"va_1001","redirectUrl":"https://app.example.com/verification-complete"}'

You must have a webhook secret set up first, or the request returns 400 with webhook_secret_required. The response depends on the currency. For BRL, expect requires_action then active: requires_action: The customer has to verify first. Send them nextStep.url.

{
  "status": "success",
  "message": "Virtual account created successfully",
  "data": {
    "uuid": "9a1c1c52-7b8e-4a52-9f0e-3e6b0a8d6c11",
    "reference": "va_1001",
    "status": "requires_action",
    "currency": "BRL",
    "type": "dedicated",
    "bankDetails": null,
    "customer": {
      "uuid": "224ca5c5-f2a6-419b-bf36-73997434d945",
      "email": "[email protected]"
    },
    "expectedAmount": null,
    "expiresAt": null,
    "nextStep": {
      "type": "verification_link",
      "url": "https://verify.example.com/abc"
    },
    "statusReason": null,
    "metadata": {
      "orderId": "12345"
    },
    "createdAt": "2026-10-16T09:31:00.000Z"
  }
}

active: Ready. Show the bank details to your payer.

{
  "status": "success",
  "message": "Virtual account created successfully",
  "data": {
    "uuid": "9a1c1c52-7b8e-4a52-9f0e-3e6b0a8d6c11",
    "reference": "va_1001",
    "status": "active",
    "currency": "BRL",
    "type": "dedicated",
    "bankDetails": {
      "rail": "pix",
      "accountName": "ACME PAY / ADA OKAFOR",
      "pixCode": "00020126580014br.gov.bcb.pix0136...6304ABCD",
      "extra": {
        "paymentRails": [
          "pix"
        ]
      }
    },
    "customer": {
      "uuid": "224ca5c5-f2a6-419b-bf36-73997434d945",
      "email": "[email protected]"
    },
    "expectedAmount": null,
    "expiresAt": null,
    "nextStep": null,
    "statusReason": null,
    "metadata": {
      "orderId": "12345"
    },
    "createdAt": "2026-10-16T09:31:00.000Z"
  }
}

If the request is rejected straight away you get 422 with the reason in errors[0].reason and no account is created. If it is rejected later you receive virtual_account.failed with a reason. See Webhooks.

4. Show the details to your payer

Show these fields from bankDetails:

Label	Field
Pix code (copy and paste)	`pixCode`

How your payer sends the money:

Open their banking app and choose Pix, then “Pix Copia e Cola”.
Paste the Pix code and confirm the amount.

5. Receive the payment

When the payment arrives you receive virtual_account.payment.received. Amounts are decimal strings in BRL; destinationAmount is in USD, after any fees.

{
  "event": "virtual_account.payment.received",
  "data": {
    "transaction": {
      "reference": "va-17912345678901234",
      "status": "Success",
      "sourceAmount": "300.00",
      "sourceCurrency": "BRL",
      "destinationAmount": "55.10",
      "destinationCurrency": "USD",
      "fees": {
        "sourceTotalFee": "0.00"
      }
    },
    "virtualAccount": {
      "uuid": "9a1c1c52-7b8e-4a52-9f0e-3e6b0a8d6c11",
      "reference": "va_1001",
      "currency": "BRL",
      "type": "dedicated"
    },
    "customer": {
      "uuid": "224ca5c5-f2a6-419b-bf36-73997434d945",
      "email": "[email protected]",
      "externalReference": null
    },
    "sender": {
      "name": "ADA OKAFOR",
      "bank": "Nubank",
      "accountNumber": "******6789"
    },
    "occurredAt": "2026-10-16T10:02:00.000Z"
  }
}

Verify the signature before you trust it, and use data.transaction.reference to ignore repeats. See Webhooks.

Things to handle

Pix supports payments from the account holder and from approved third parties only, so payments from other senders may be held for review.
The Pix code can also be shown as a QR code by your own UI.
A payment can be held for review. You receive virtual_account.payment.manual_review with a review.reason, then received or rejected after a decision.
GET /virtual-accounts/{uuid} returns the current status at any time, and POST /virtual-accounts/{uuid}/deactivate stops the account accepting payments.

Get Started

Customers

Multi-currency Virtual Accounts

Webhooks

1. Check availability

2. Create the customer

3. Request the account

4. Show the details to your payer

5. Receive the payment

Things to handle

​1. Check availability

​2. Create the customer

​3. Request the account

​4. Show the details to your payer

​5. Receive the payment

​Things to handle

1. Check availability

2. Create the customer

3. Request the account

4. Show the details to your payer

5. Receive the payment

Things to handle