> ## Documentation Index > Fetch the complete documentation index at: https://docs.useroutr.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a webhook event ## OpenAPI ````yaml /api-reference/openapi.json get /v1/webhooks/events/{id} openapi: 3.1.0 info: title: Useroutr API version: '1' description: >- Application funding infrastructure. Two authentication layers exist and are never interchangeable: developer backends authenticate with an application API key (`apiKey`), and the Useroutr dashboard authenticates a human with a Useroutr account session (`userSession`, obtained from `/v1/auth/sign-in`). Platform operations use the operator platform key. Every response carries an `X-Request-ID` header that also appears in error envelopes. servers: - url: https://api.sandbox.useroutr.com description: 'Sandbox: ur_test_ keys, Stellar testnet' - url: https://api.useroutr.com description: 'Production: ur_live_ keys' security: [] tags: - name: Funding Intents description: Funding intent lifecycle - name: Quotes description: 'Route quotes: what a payer must send from a chosen source asset' - name: Checkout description: Public, token-addressed payer view - name: Payments description: Observed payments - name: Settlements description: Settlement state and protocol evidence - name: Refunds description: Refund requests for payments that did not satisfy an intent - name: Ledger description: Application balances and ledger entries - name: Webhooks description: Webhook endpoints, events and deliveries - name: Assets description: Supported assets - name: Applications description: Application registration and credentials - name: Request logs description: Requests made with the application's API keys, kept for 30 days paths: /v1/webhooks/events/{id}: get: tags: - Webhooks summary: Retrieve a webhook event parameters: - schema: type: string minLength: 1 maxLength: 64 in: path name: id required: true responses: '200': description: Default Response content: application/json: schema: oneOf: - type: object properties: id: type: string object: type: string enum: - event api_version: type: string enum: - '1' application_id: type: string funding_intent_id: type: - string - 'null' created_at: type: string type: type: string enum: - funding.created - funding.partially_funded - funding.payment_confirmed - funding.settling - funding.settled - funding.credited - funding.failed - funding.expired data: type: object properties: object: type: object properties: id: type: string object: type: string enum: - funding_intent application_id: type: string requirement: type: object properties: amount: type: string asset: type: string required: - amount - asset additionalProperties: false destination: type: object properties: network: type: string minLength: 1 maxLength: 32 asset: type: string minLength: 1 maxLength: 100 address: type: string minLength: 1 maxLength: 128 required: - network - asset - address additionalProperties: false source: anyOf: - type: object properties: network: type: string asset: type: string amount: type: string required: - network - asset - amount additionalProperties: false - type: 'null' quote: anyOf: - type: object properties: id: type: string object: type: string enum: - quote funding_intent_id: type: string application_id: type: string type: type: string enum: - EXACT_INPUT - EXACT_OUTPUT status: type: string enum: - ACTIVE - SELECTED - LOCKED - EXECUTING - COMPLETED - EXPIRED - FAILED - CANCELLED stellar_network: type: string enum: - testnet - mainnet - local source: type: object properties: network: type: string asset: type: string amount: type: string expected_amount: type: string required: - network - asset - amount - expected_amount additionalProperties: false destination: type: object properties: network: type: string asset: type: string address: type: string amount: type: string minimum_amount: type: string required: - network - asset - address - amount - minimum_amount additionalProperties: false route: type: object properties: type: type: string enum: - DIRECT_STELLAR - STELLAR_SWAP - CROSS_CHAIN - COMPOSED - DIRECT_EVM provider: type: string steps: type: array items: type: object properties: type: type: string provider: type: string source_asset: type: string destination_asset: type: string required: - type - provider - source_asset - destination_asset additionalProperties: false estimated_duration_seconds: type: integer minimum: -9007199254740991 maximum: 9007199254740991 confidence: type: integer minimum: -9007199254740991 maximum: 9007199254740991 price_impact_bps: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' score: type: string required: - type - provider - steps - estimated_duration_seconds - confidence - price_impact_bps - score additionalProperties: false fees: type: object properties: items: type: array items: type: object properties: type: type: string enum: - NETWORK - PROVIDER - SWAP - BRIDGE - USEROUTR asset: type: string amount: type: string required: - type - asset - amount additionalProperties: false total: type: string required: - items - total additionalProperties: false exchange_rate: type: string slippage_bps: type: integer minimum: -9007199254740991 maximum: 9007199254740991 execution: anyOf: - type: object properties: id: type: string object: type: string enum: - route_execution quote_id: type: string funding_intent_id: type: string provider: type: string route_type: type: string enum: - DIRECT_STELLAR - STELLAR_SWAP - CROSS_CHAIN - COMPOSED - DIRECT_EVM status: type: string enum: - PENDING - SUBMITTED - CONFIRMING - COMPLETED - FAILED - UNKNOWN phase: anyOf: - type: string enum: - CREATED - SOURCE_PENDING - SOURCE_CONFIRMED - MESSAGE_PENDING - DESTINATION_PENDING - DESTINATION_CONFIRMED - VERIFICATION_PENDING - COMPLETED - FAILED - type: 'null' provider_execution_id: type: - string - 'null' transaction_hashes: type: array items: type: string failure: anyOf: - type: object properties: code: type: string message: type: string required: - code - message additionalProperties: false - type: 'null' started_at: type: string completed_at: type: - string - 'null' required: - id - object - quote_id - funding_intent_id - provider - route_type - status - phase - provider_execution_id - transaction_hashes - failure - started_at - completed_at additionalProperties: false - type: 'null' failure: anyOf: - type: object properties: code: type: string message: type: string required: - code - message additionalProperties: false - type: 'null' expires_at: type: string lock_expires_at: type: - string - 'null' created_at: type: string updated_at: type: string required: - id - object - funding_intent_id - application_id - type - status - stellar_network - source - destination - route - fees - exchange_rate - slippage_bps - execution - failure - expires_at - lock_expires_at - created_at - updated_at additionalProperties: false - type: 'null' route: anyOf: - type: object properties: type: type: string enum: - DIRECT_STELLAR - STELLAR_SWAP - CROSS_CHAIN - COMPOSED - DIRECT_EVM provider: type: string required: - type - provider additionalProperties: false - type: 'null' status: type: string enum: - CREATED - AWAITING_PAYMENT - PARTIALLY_FUNDED - PAYMENT_DETECTED - PAYMENT_CONFIRMED - ROUTING - SETTLING - SETTLED - CREDITED - FAILED - REFUND_PENDING - REFUNDED - EXPIRED - CANCELLED received_amount: type: string deposit_account: anyOf: - type: object properties: id: type: string object: type: string enum: - deposit_account network: type: string enum: - stellar address: type: string asset: type: string status: type: string enum: - PROVISIONING - ACTIVE - RETIRING - RETIRED - FAILED created_at: type: string activated_at: type: - string - 'null' retired_at: type: - string - 'null' required: - id - object - network - address - asset - status - created_at - activated_at - retired_at additionalProperties: false - type: 'null' reference: type: - string - 'null' metadata: type: object propertyNames: type: string minLength: 1 maxLength: 64 additionalProperties: anyOf: - type: string maxLength: 1000 - type: number - type: boolean - type: 'null' protocol: type: object properties: intent_id: type: string contract_id: type: string status: type: string enum: - PENDING - SUBMITTED - CONFIRMED - FAILED transaction_hash: type: - string - 'null' required: - intent_id - contract_id - status - transaction_hash additionalProperties: false funding_instructions: anyOf: - anyOf: - type: object properties: network: type: string enum: - stellar stellar_network: type: string enum: - testnet - mainnet - local deposit: type: object properties: address: type: string type: type: string enum: - account required: - address - type additionalProperties: false asset: type: object properties: id: type: string symbol: type: string stellar_asset: type: string code: type: string issuer: type: - string - 'null' contract: type: string decimals: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - id - symbol - stellar_asset - code - issuer - contract - decimals additionalProperties: false amount: type: string required_amount: type: string received_amount: type: string expires_at: type: string required: - network - stellar_network - deposit - asset - amount - required_amount - received_amount - expires_at additionalProperties: false - type: object properties: network: type: string chain_id: type: integer minimum: -9007199254740991 maximum: 9007199254740991 deposit: type: object properties: address: type: string type: type: string enum: - contract required: - address - type additionalProperties: false asset: type: object properties: id: type: string symbol: type: string contract: type: string decimals: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - id - symbol - contract - decimals additionalProperties: false amount: type: string required_amount: type: string received_amount: type: string expires_at: type: string required: - network - chain_id - deposit - asset - amount - required_amount - received_amount - expires_at additionalProperties: false - type: 'null' payment: anyOf: - type: object properties: id: type: string object: type: string enum: - payment funding_intent_id: type: - string - 'null' network: type: string stellar_network: type: string enum: - testnet - mainnet - local asset: type: - string - 'null' stellar_asset: type: string amount: type: string payer_address: type: - string - 'null' destination_address: type: string transaction_hash: type: - string - 'null' operation_id: type: - string - 'null' ledger: type: integer minimum: -9007199254740991 maximum: 9007199254740991 memo: anyOf: - type: object properties: type: type: string enum: - text - id - hash - return value: type: string required: - type - value additionalProperties: false - type: 'null' status: type: string enum: - DETECTED - CONFIRMING - CONFIRMED - INVALID - FAILED failure: anyOf: - type: object properties: code: type: string message: type: string required: - code - message additionalProperties: false - type: 'null' detected_at: type: string confirmed_at: type: - string - 'null' required: - id - object - funding_intent_id - network - stellar_network - asset - stellar_asset - amount - payer_address - destination_address - transaction_hash - operation_id - ledger - memo - status - failure - detected_at - confirmed_at additionalProperties: false - type: 'null' settlement: anyOf: - type: object properties: id: type: string object: type: string enum: - settlement funding_intent_id: type: string application_id: type: string payment_id: type: string network: type: string enum: - stellar stellar_network: type: string enum: - testnet - mainnet - local route: type: string enum: - direct - stellar_swap - cross_chain - composed source: type: object properties: asset: type: string amount: type: string required: - asset - amount additionalProperties: false destination: type: object properties: network: type: string asset: type: string address: type: string amount: type: string required: - network - asset - address - amount additionalProperties: false transaction_hash: type: string transfer_transaction_hash: type: - string - 'null' protocol: type: object properties: settlement_id: type: string contract_id: type: string create_transaction_hash: type: - string - 'null' confirm_transaction_hash: type: - string - 'null' required: - settlement_id - contract_id - create_transaction_hash - confirm_transaction_hash additionalProperties: false status: type: string enum: - PENDING - SUBMITTED - CONFIRMING - CONFIRMED - FAILED reconciliation_status: type: string enum: - UNRECONCILED - VERIFYING - MATCHED - EXCEPTION failure: anyOf: - type: object properties: code: type: string message: type: string required: - code - message additionalProperties: false - type: 'null' submitted_at: type: - string - 'null' confirmed_at: type: - string - 'null' created_at: type: string updated_at: type: string required: - id - object - funding_intent_id - application_id - payment_id - network - stellar_network - route - source - destination - transaction_hash - transfer_transaction_hash - protocol - status - reconciliation_status - failure - submitted_at - confirmed_at - created_at - updated_at additionalProperties: false - type: 'null' failure: anyOf: - type: object properties: code: type: string message: type: string required: - code - message additionalProperties: false - type: 'null' hosted_funding_url: type: - string - 'null' expires_at: type: string created_at: type: string updated_at: type: string required: - id - object - application_id - requirement - destination - source - quote - route - status - received_amount - deposit_account - reference - metadata - protocol - funding_instructions - payment - settlement - failure - hosted_funding_url - expires_at - created_at - updated_at additionalProperties: false required: - object additionalProperties: false required: - id - object - api_version - application_id - funding_intent_id - created_at - type - data additionalProperties: false - type: object properties: id: type: string object: type: string enum: - event api_version: type: string enum: - '1' application_id: type: string funding_intent_id: type: - string - 'null' created_at: type: string type: type: string enum: - payment.rejected data: type: object properties: object: type: object properties: id: type: string object: type: string enum: - payment funding_intent_id: type: - string - 'null' network: type: string stellar_network: type: string enum: - testnet - mainnet - local asset: type: - string - 'null' stellar_asset: type: string amount: type: string payer_address: type: - string - 'null' destination_address: type: string transaction_hash: type: - string - 'null' operation_id: type: - string - 'null' ledger: type: integer minimum: -9007199254740991 maximum: 9007199254740991 memo: anyOf: - type: object properties: type: type: string enum: - text - id - hash - return value: type: string required: - type - value additionalProperties: false - type: 'null' status: type: string enum: - DETECTED - CONFIRMING - CONFIRMED - INVALID - FAILED failure: anyOf: - type: object properties: code: type: string message: type: string required: - code - message additionalProperties: false - type: 'null' detected_at: type: string confirmed_at: type: - string - 'null' required: - id - object - funding_intent_id - network - stellar_network - asset - stellar_asset - amount - payer_address - destination_address - transaction_hash - operation_id - ledger - memo - status - failure - detected_at - confirmed_at additionalProperties: false required: - object additionalProperties: false required: - id - object - api_version - application_id - funding_intent_id - created_at - type - data additionalProperties: false - type: object properties: id: type: string object: type: string enum: - event api_version: type: string enum: - '1' application_id: type: string funding_intent_id: type: - string - 'null' created_at: type: string type: type: string enum: - refund.created - refund.completed - refund.failed - refund.destination_required data: type: object properties: object: type: object properties: id: type: string object: type: string enum: - refund funding_intent_id: type: string payment_id: type: string application_id: type: string asset: type: string amount: type: string destination: type: object properties: network: type: string asset: type: string address: type: - string - 'null' memo: anyOf: - oneOf: - type: object properties: type: type: string enum: - text value: type: string minLength: 1 required: - type - value additionalProperties: false - type: object properties: type: type: string enum: - id value: type: string pattern: ^\d{1,20}$ required: - type - value additionalProperties: false - type: object properties: type: type: string enum: - hash value: type: string pattern: ^[0-9a-fA-F]{64}$ required: - type - value additionalProperties: false - type: 'null' required: - network - asset - address - memo additionalProperties: false reason: type: string enum: - UNDERPAYMENT - OVERPAYMENT - WRONG_ASSET - EXPIRED_INTENT - DUPLICATE_PAYMENT - SETTLEMENT_FAILED - ROUTE_REMAINDER - ROUTE_SURPLUS - MANUAL status: type: string enum: - PENDING - PROCESSING - COMPLETED - FAILED transaction_hash: type: - string - 'null' failure: anyOf: - type: object properties: code: type: string message: type: string required: - code - message additionalProperties: false - type: 'null' created_at: type: string completed_at: type: - string - 'null' required: - id - object - funding_intent_id - payment_id - application_id - asset - amount - destination - reason - status - transaction_hash - failure - created_at - completed_at additionalProperties: false required: - object additionalProperties: false required: - id - object - api_version - application_id - funding_intent_id - created_at - type - data additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - BAD_REQUEST - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - IDEMPOTENCY_KEY_REQUIRED - IDEMPOTENCY_KEY_REUSED - IDEMPOTENCY_REQUEST_IN_PROGRESS - APPLICATION_INACTIVE - INVALID_AMOUNT - UNSUPPORTED_ASSET - INVALID_DESTINATION - INVALID_EXPIRATION - PROTOCOL_REJECTED - PROTOCOL_UNAVAILABLE - NO_ROUTE_AVAILABLE - INSUFFICIENT_INPUT - QUOTE_EXPIRED - QUOTE_NOT_SELECTABLE - QUOTE_NOT_LOCKED - EXECUTION_NOT_FAILED - EXECUTION_NOT_RESUMABLE - LOGO_FORMAT_UNSUPPORTED - LOGO_DIMENSIONS_INVALID - LOGO_STORAGE_UNAVAILABLE - ROUTE_UNAVAILABLE - RATE_LIMITED - INVALID_CREDENTIALS - EMAIL_NOT_VERIFIED - EMAIL_ALREADY_REGISTERED - SESSION_EXPIRED - INVALID_TOKEN - INTERNAL_ERROR message: type: string requestId: type: string retryable: type: boolean details: type: array items: type: object properties: path: type: string message: type: string required: - path - message additionalProperties: false required: - code - message - requestId additionalProperties: false required: - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - BAD_REQUEST - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - IDEMPOTENCY_KEY_REQUIRED - IDEMPOTENCY_KEY_REUSED - IDEMPOTENCY_REQUEST_IN_PROGRESS - APPLICATION_INACTIVE - INVALID_AMOUNT - UNSUPPORTED_ASSET - INVALID_DESTINATION - INVALID_EXPIRATION - PROTOCOL_REJECTED - PROTOCOL_UNAVAILABLE - NO_ROUTE_AVAILABLE - INSUFFICIENT_INPUT - QUOTE_EXPIRED - QUOTE_NOT_SELECTABLE - QUOTE_NOT_LOCKED - EXECUTION_NOT_FAILED - EXECUTION_NOT_RESUMABLE - LOGO_FORMAT_UNSUPPORTED - LOGO_DIMENSIONS_INVALID - LOGO_STORAGE_UNAVAILABLE - ROUTE_UNAVAILABLE - RATE_LIMITED - INVALID_CREDENTIALS - EMAIL_NOT_VERIFIED - EMAIL_ALREADY_REGISTERED - SESSION_EXPIRED - INVALID_TOKEN - INTERNAL_ERROR message: type: string requestId: type: string retryable: type: boolean details: type: array items: type: object properties: path: type: string message: type: string required: - path - message additionalProperties: false required: - code - message - requestId additionalProperties: false required: - error additionalProperties: false security: - apiKey: [] x-codeSamples: - lang: typescript label: Node.js SDK source: >- import { Useroutr } from "@useroutr/sdk"; const useroutr = new Useroutr({ apiKey: process.env.USEROUTR_API_KEY }); const event = await useroutr.webhooks.events.retrieve("evt_0d5e8c26"); - lang: bash label: cURL source: >- curl -X GET "https://api.sandbox.useroutr.com/v1/webhooks/events/evt_0d5e8c26" \ -H "Authorization: Bearer $USEROUTR_API_KEY" components: securitySchemes: apiKey: type: http scheme: bearer description: >- Application API authentication for developer backends: `Authorization: Bearer ur_test_...` or `ur_live_...`. Resolves the application, its environment and the key's status. Never a dashboard login. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.