CAD virtual accounts (Canada)

Enabled on request. Foreign currency accounts have to be enabled for your account first. Ask Pagoramp to request it.


Country	Canada
Payment rail	Interac e-Transfer
Account types	dedicated
Customers	Individuals and businesses
When it is ready	The customer or business is reviewed before approval, so the account shows `pending` until then.

1. Check availability

Ask what CAD 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=CAD" \
  -H "x-api-key: YOUR_API_KEY"

2. Create the customer

Required for an individual: firstname, lastname, email, phone, dateOfBirth, nationality, occupation, address.line1, address.city, address.state, address.postalCode, address.country, documents (type id_document), documents (type utility_bill). 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]","phone":"+14165550132","dateOfBirth":"1990-06-15","nationality":"CA","occupation":"Engineer","address":{"line1":"100 King St W","city":"Toronto","state":"ON","postalCode":"M5X 1A9","country":"CA"},"documents":[{"type":"id_document","url":"https://files.example.com/id.pdf"},{"type":"utility_bill","url":"https://files.example.com/utility-bill.pdf"}]}'

The customer is created with kycStatus incomplete or pending. Anything missing for CAD 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":"CAD","type":"dedicated","reference":"va_1001","termsAcceptance":{"acceptedAt":"2026-10-16T09:30:00.000Z","ipAddress":"102.89.0.1"}}'

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 CAD, expect pending then active: pending: The account is still being issued or approved. Wait for virtual_account.created.

{
  "status": "success",
  "message": "Virtual account created successfully",
  "data": {
    "uuid": "9a1c1c52-7b8e-4a52-9f0e-3e6b0a8d6c11",
    "reference": "va_1001",
    "status": "pending",
    "currency": "CAD",
    "type": "dedicated",
    "bankDetails": null,
    "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"
  }
}

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": "CAD",
    "type": "dedicated",
    "bankDetails": {
      "rail": "interac_e_transfer",
      "accountName": "Ada Okafor",
      "interacEmail": "[email protected]"
    },
    "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
Interac e-Transfer email	`interacEmail`

How your payer sends the money:

Open their Canadian banking app and choose Interac e-Transfer.
Send to the email shown.

5. Receive the payment

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

{
  "event": "virtual_account.payment.received",
  "data": {
    "transaction": {
      "reference": "va-17912345678901234",
      "status": "Success",
      "sourceAmount": "100.00",
      "sourceCurrency": "CAD",
      "destinationAmount": "72.50",
      "destinationCurrency": "USD",
      "fees": {
        "sourceTotalFee": "0.00"
      }
    },
    "virtualAccount": {
      "uuid": "9a1c1c52-7b8e-4a52-9f0e-3e6b0a8d6c11",
      "reference": "va_1001",
      "currency": "CAD",
      "type": "dedicated"
    },
    "customer": {
      "uuid": "224ca5c5-f2a6-419b-bf36-73997434d945",
      "email": "[email protected]",
      "externalReference": null
    },
    "sender": {
      "name": "ADA OKAFOR",
      "bank": "RBC",
      "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

CAD needs the most detail: date of birth, address, an ID document and a utility bill for individuals, and registration details, owners and incorporation documents for businesses. Documents are https links.
You confirm that the customer accepted the account terms: termsAcceptance on the API, a checkbox in the dashboard.
Approval takes time. You receive virtual_account.created when it is approved or virtual_account.failed with the reason.
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