> ## 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. # Create a payment route for a customer > Creates a standing payment route under the customer identified in the URL. ## What this endpoint does Creates a standing payment route under the customer identified in the URL. ## When to use it Use this customer-scoped form when your integration already works from a customer record. ## Before you call Use a secret API key with route write access. The customer must belong to this tenant account and have the required approved entitlement. ## Money and balance effect Creating the route does not move money. Funding the issued instructions later starts a transfer. ## States and completion Creation confirms route provisioning, not funding or settlement. Track each later funding through its transfer. ## Safe retries Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out. Read [Payment routes](/console/payment-routes) for the complete workflow. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/customers/{customerId}/payment-routes 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/customers/{customerId}/payment-routes: post: tags: - Payment routes summary: Create a payment route for a customer description: >- Creates a standing payment route under the customer identified in the URL. Use this customer-scoped form when your integration already works from a customer record. operationId: CustomerPaymentRouteController2_create_v1 parameters: - name: customerId required: true in: path schema: type: string - name: Idempotency-Key in: header required: true description: >- A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response. schema: type: string minLength: 8 maxLength: 255 example: 13bda8d7-87bd-4fa4-b7d5-e740725f9bd2 requestBody: required: true content: application/json: schema: oneOf: - type: object properties: direction: description: >- The customer funds AUD and receives stablecoin at the destination address. type: string enum: - aud_to_stablecoin destination: description: Where the converted stablecoin is delivered. 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: description: >- Optional per-route min/max/daily limits; a deposit outside them is held, not converted. type: object properties: min: type: string max: type: string daily: type: string metadata: type: object additionalProperties: type: string required: - direction - destination - type: object properties: direction: description: >- The customer sends stablecoin and receives AUD at the destination bank account or PayID. type: string enum: - stablecoin_to_aud destination: description: >- The AUD payout target (bank account or PayID) plus the stablecoin asset/network the customer sends. 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: description: >- Optional per-route min/max/daily limits; a deposit outside them is held, not converted. type: object properties: min: type: string max: type: string daily: type: string metadata: type: object additionalProperties: type: string required: - direction - destination responses: '201': description: The created payment route with deposit instructions. 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 '400': description: Validation failed (destination mismatches direction, etc.). '403': description: Customer not verified or not entitled for this direction. '404': description: No such customer for this account. '409': description: Idempotency-Key reused with a different request body. 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. ````