Skip to navigation

Get available VRNs

View as Markdown

Returns a list of JPM Virtual Routing Numbers (VRNs) that are currently available for subaccount assignment.

This endpoint is specifically for JPM bank configurations. It helps you identify which VRN account numbers from your configured pool are unassigned and ready to be used when creating new subaccounts.

Use Cases

  • Check capacity before creating multiple subaccounts
  • Identify specific VRNs for integration with payment processors
  • Audit current VRN usage across your subaccounts

Response Body

FieldTypeDescription
dataArrayArray of available VRN objects
data[].account_numberStringVRN account number available for assignment

Notes

  • Only available for entities with JPM bank configurations
  • Returns an empty array if all VRNs are currently assigned
  • VRN availability is checked in real-time against existing subaccounts
  • No pagination needed - typical VRN pool sizes are small (10-50 VRNs)
  • VRN availability can change between calling this endpoint and creating a subaccount if another client creates one

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Response

Available VRNs retrieved successfully