> ## Documentation Index > Fetch the complete documentation index at: https://docs.rails.wayex.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a payment route > Returns configuration and current status for one standing payment route. ## What this endpoint does Returns configuration and current status for one standing payment route. ## When to use it Use it to display route detail, validate its state, or follow a route reference from a transfer. ## Before you call Authenticate with route read access and pass a route ID owned by the same tenant account. ## Money and balance effect This is a read-only request. It does not reserve, debit, credit, or settle money. ## States and completion The route status does not describe an individual funding. Read the linked transfer for conversion and settlement state. ## Safe retries GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`. Read [Payment routes](/console/payment-routes) for the complete workflow. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/payment-routes/{id} openapi: 3.0.0 info: title: Wayex API description: >- Wayex APIs for direct customer payment routes and isolated, prefunded Treasury accounts. Each API key is bound to one tenant account and its own wallet, settings, webhooks, and reporting. version: 1.0.0 contact: {} servers: - url: https://api.sandbox.wayex.com description: Sandbox integration environment security: - Bearer: [] - ApiKey: [] tags: - name: Treasury description: >- Prefunded AUD and stablecoin wallets for one isolated tenant account. Fund, pay, convert, withdraw, track, and reconcile without selecting another account. - name: Customers description: >- Onboard end customers, run verification, and manage each customer's entitlements. - name: Payment routes description: >- Standing deposit instructions per customer. When a customer funds a route, Wayex auto-converts at the live rate and pays out/sends — no quote, no lock. - name: Transfers description: >- Read the conversion records produced when customers fund payment routes — the live activity feed and per-conversion lifecycle timeline. - name: Rates description: >- The live indicative AUD↔stablecoin rate right now — the all-in rate Wayex quotes. Indicative only; the binding price is struck when a route's funds land. - name: Revenue description: Your developer-fee revenue over time. - name: Invoices description: >- Your monthly invoices — Wayex platform fees due, net of your accrued developer-fee credit. - name: Webhooks description: Subscribe to HMAC-signed event webhooks and inspect deliveries. - name: API keys description: Create, list, and rotate API keys for programmatic access. - name: Fees description: >- Configure your developer fee — the markup withheld from each conversion and credited against your monthly invoice. - name: Invitations description: Accept a team invitation and activate your account. paths: /v1/payment-routes/{id}: get: tags: - Payment routes summary: Get a payment route description: >- Returns configuration and current status for one standing payment route. Use it to display route detail, validate its state, or follow a route reference from a transfer. operationId: PaymentRouteController2_get_v1 parameters: - name: id required: true in: path schema: type: string responses: '200': description: The payment route. content: application/json: schema: oneOf: - type: object properties: id: type: string minLength: 1 counterpartyId: description: >- The client account (counterparty) this route belongs to. For API callers this is always your own account id. type: string minLength: 1 customerId: type: string minLength: 1 direction: type: string enum: - aud_to_stablecoin destination: type: object properties: network: description: The network the stablecoin is delivered on. type: string enum: - ethereum - base - arbitrum - optimism - polygon - bsc - avalanche - solana - tron address: description: >- The destination crypto address the converted stablecoin is sent to. type: string minLength: 1 currency: description: Which stablecoin to deliver. type: string enum: - USDC - USDT required: - network - address - currency limits: type: object properties: min: type: string max: type: string daily: type: string status: type: string enum: - active - inactive instructions: type: object properties: title: type: string minLength: 1 reference: type: string minLength: 1 deposit: oneOf: - type: object properties: kind: type: string enum: - aud bsb: type: string minLength: 1 accountNumber: type: string minLength: 1 payId: type: object properties: type: type: string enum: - email - phone - abn value: type: string minLength: 1 required: - type - value reference: type: string minLength: 1 required: - kind - bsb - accountNumber - reference - type: object properties: kind: type: string enum: - crypto network: type: string enum: - ethereum - base - arbitrum - optimism - polygon - bsc - avalanche - solana - tron address: type: string minLength: 1 asset: type: string enum: - USDC - USDT required: - kind - network - address - asset destinationSummary: type: string minLength: 1 limits: type: object properties: min: type: string max: type: string daily: type: string steps: type: array items: type: string required: - title - reference - deposit - destinationSummary - steps createdAt: type: string format: date-time required: - id - counterpartyId - customerId - direction - destination - status - instructions - createdAt - type: object properties: id: type: string minLength: 1 counterpartyId: description: >- The client account (counterparty) this route belongs to. For API callers this is always your own account id. type: string minLength: 1 customerId: type: string minLength: 1 direction: type: string enum: - stablecoin_to_aud destination: oneOf: - type: object properties: bankAccount: type: object properties: accountHolderName: description: Name on the destination AUD bank account. type: string minLength: 1 bsb: description: >- The 6-digit BSB of the destination AUD bank account. type: string minLength: 1 accountNumber: description: The destination AUD bank account number. type: string minLength: 1 required: - accountHolderName - bsb - accountNumber asset: type: string enum: - USDC - USDT network: type: string enum: - ethereum - base - arbitrum - optimism - polygon - bsc - avalanche - solana - tron required: - bankAccount - asset - network - type: object properties: payId: type: object properties: type: type: string enum: - email - phone - abn value: type: string minLength: 1 required: - type - value asset: type: string enum: - USDC - USDT network: type: string enum: - ethereum - base - arbitrum - optimism - polygon - bsc - avalanche - solana - tron required: - payId - asset - network limits: type: object properties: min: type: string max: type: string daily: type: string status: type: string enum: - active - inactive instructions: type: object properties: title: type: string minLength: 1 reference: type: string minLength: 1 deposit: oneOf: - type: object properties: kind: type: string enum: - aud bsb: type: string minLength: 1 accountNumber: type: string minLength: 1 payId: type: object properties: type: type: string enum: - email - phone - abn value: type: string minLength: 1 required: - type - value reference: type: string minLength: 1 required: - kind - bsb - accountNumber - reference - type: object properties: kind: type: string enum: - crypto network: type: string enum: - ethereum - base - arbitrum - optimism - polygon - bsc - avalanche - solana - tron address: type: string minLength: 1 asset: type: string enum: - USDC - USDT required: - kind - network - address - asset destinationSummary: type: string minLength: 1 limits: type: object properties: min: type: string max: type: string daily: type: string steps: type: array items: type: string required: - title - reference - deposit - destinationSummary - steps createdAt: type: string format: date-time required: - id - counterpartyId - customerId - direction - destination - status - instructions - createdAt '404': description: No such payment route for this account. security: - Bearer: [] - ApiKey: [] components: securitySchemes: Bearer: type: http scheme: bearer bearerFormat: Wayex API key description: 'Send the same Wayex API key as `Authorization: Bearer `.' ApiKey: type: apiKey in: header name: X-Api-Key description: A Wayex API key. Use a secret key for write operations. ````