> ## Documentation Index > Fetch the complete documentation index at: https://docs.spritz.finance/llms.txt > Use this file to discover all available pages before exploring further. # Get an on-ramp > Returns details for a specific on-ramp transaction. ## OpenAPI ````yaml https://platform.spritz.finance/openapi.json get /v1/on-ramps/{onRampId} openapi: 3.0.3 info: title: Spritz Finance API version: 1.0.0 description: API for the Spritz Finance platform with RFC 9457 error handling servers: - url: https://platform.spritz.finance description: Production - url: https://sandbox.spritz.finance description: Sandbox security: [] tags: - name: Users description: User management endpoints - name: Bank Accounts description: Manage bank accounts for off-ramp destinations - name: Bills description: Manage bill pay accounts - name: Cards description: Spritz-issued debit cards - name: Auto-Ramp Accounts description: Virtual bank accounts that automatically convert fiat deposits to crypto - name: Spritz App description: >- Endpoints used by the Spritz app and internal SDKs. Excluded from the public partner spec. paths: /v1/on-ramps/{onRampId}: get: tags: - On-Ramps summary: Get an on-ramp description: Returns details for a specific on-ramp transaction. operationId: getV1On-rampsByOnRampId parameters: - name: onRampId in: path required: true schema: description: The on-ramp ID type: string example: onramp_xyz789 responses: '200': description: Response for status 200 content: application/json: schema: type: object properties: id: description: Unique on-ramp identifier type: string example: onramp_xyz789 status: type: string enum: - awaiting_payment - processing - partially_delivered - completed - cancelled - failed - reversed - refunded - in_review createdAt: format: date-time type: string input: type: object properties: amount: description: Fiat amount sent, before fees type: string example: '5187.50' currency: type: string enum: - USD - CAD - EUR - GBP rail: type: string enum: - ach_credit - wire - sepa_credit_transfer required: - amount - currency - rail fees: type: object properties: amount: description: >- Every fee paid on this on-ramp, in source currency — the sum of `breakdown`. `input.amount - fees.amount` is what reaches the destination. On on-ramps created before pass-through fees were recorded, `breakdown` is absent and this covers Spritz's fee only. type: string example: '59.60' currency: description: Currency of the fee paid type: string example: USD, EUR breakdown: description: >- Every fee the user paid, split by role, in source currency. Omitted on on-ramps created before pass-through fees were recorded — absent means unknown, not zero. type: object properties: platform: description: Spritz's own fee. type: string example: '57.07' exchange: description: >- Total currency-conversion cost passed through to the user, whether the provider charged it as a fee or took it inside the exchange rate. `0.00` only when no conversion took place. type: string example: '2.53' network: description: >- On-chain settlement cost passed through to the user. `0.00` on networks that do not charge it — and, on an estimate, also where too few deposits have settled for us to have measured one. `fees.networkFeeSamples` separates the two there; on a settled on-ramp this is always the cost actually charged. type: string example: '0.00' required: - platform - exchange - network required: - amount - currency output: type: object properties: amount: description: Total crypto amount expected for this on-ramp type: string example: '5130.43' token: description: Token to be received type: string example: USDC network: type: string enum: - ethereum - polygon - base - arbitrum - avalanche - optimism - solana - tron - bitcoin address: description: Destination wallet address type: string example: 0x742d35Cc... txHash: description: >- Legacy convenience transaction hash for single-delivery payouts type: string example: 0xabc... required: - amount - token - network - address source: description: >- Where the fiat for this on-ramp originated. Present when the on-ramp was funded by debiting a linked funding source (ACH debit); null when funds were pushed from an external bank account (ach_credit, wire, sepa_credit_transfer). type: object properties: fundingSourceId: description: >- Opaque public identifier of the funding source that was debited type: string example: fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X required: - fundingSourceId nullable: true deliverySummary: type: object properties: deliveredAmount: description: Crypto amount delivered or submitted so far type: string example: '40.00' confirmedAmount: description: Crypto amount confirmed on-chain so far type: string example: '25.00' remainingAmount: description: Crypto amount still remaining to be delivered type: string example: '60.00' required: - deliveredAmount - confirmedAmount - remainingAmount deliveries: type: array items: type: object properties: id: description: Unique delivery identifier type: string example: release_abc123 status: type: string enum: - queued - submitted - confirmed - failed amount: description: Crypto amount for this delivery tranche type: string example: '25.00' amountUsd: description: USD equivalent of this delivery tranche type: string example: '25.00' txHash: description: >- Blockchain transaction hash for this delivery tranche type: string example: 0xabc... createdAt: format: date-time type: string submittedAt: format: date-time type: string confirmedAt: format: date-time type: string failedAt: format: date-time type: string required: - id - status - amount - amountUsd - createdAt completedAt: format: date-time type: string required: - id - status - createdAt - input - fees - source '401': description: Response for status 401 content: application/json: schema: type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string example: urn:problem-type:auth:unauthorized title: description: A short, human-readable summary of the problem type type: string example: Unauthorized status: description: The HTTP status code type: number example: 401 detail: description: A human-readable explanation specific to this occurrence type: string example: Bearer token required instance: description: A URI reference that identifies the specific occurrence type: string realm: description: The authentication realm type: string example: API scope: description: The required scope for this resource type: string example: read:users required: - title - status additionalProperties: false '404': description: Response for status 404 content: application/json: schema: type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string title: description: A short, human-readable summary of the problem type type: string status: description: The HTTP status code type: number example: 404 detail: description: A human-readable explanation specific to this occurrence type: string instance: description: A URI reference that identifies the specific occurrence type: string resourceType: description: The type of resource that was not found type: string example: user resourceId: description: The identifier of the resource that was not found type: string required: - title - status - resourceType - resourceId additionalProperties: false '500': description: Response for status 500 content: application/json: schema: type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string example: urn:problem-type:auth:unauthorized title: description: A short, human-readable summary of the problem type type: string example: Unauthorized status: description: The HTTP status code type: number example: 400 detail: description: A human-readable explanation specific to this occurrence type: string instance: description: A URI reference that identifies the specific occurrence type: string example: /errors/1234567890 code: description: >- Machine-readable cause, present when exactly one thing failed. Branch on this, never on `detail`, which is human-facing copy and may change. For deposit limits the vocabulary matches the `reason` values the limits API returns pre-flight. type: string example: transaction_limit field: description: The offending request field, present alongside `code`. type: string example: amountUsd retryable: description: >- Whether retrying the same request later may succeed without changing its inputs. type: boolean example: true required: - title - status additionalProperties: false security: - bearerAuth: [] - integratorJwt: [] - hmacAuth: [] integratorKey: [] timestamp: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Cognito JWT token for regular user authentication integratorJwt: type: http scheme: bearer bearerFormat: JWT description: >- Integrator JWT token (prefix: spr_) for frontend integrator authentication. Obtained via token exchange endpoint. hmacAuth: type: apiKey in: header name: X-Signature description: >- HMAC signature authentication for backend integrators. **Required Headers:** - X-Integrator-Key: Integrator API key (format: int_...) - X-Signature: HMAC signature (format: sha256={hex}) - X-Timestamp: Unix timestamp in milliseconds - Authorization: Bearer {user-api-key} **Signature Algorithm:** HMAC-SHA256 **Signature Format:** {timestamp}.{METHOD}.{path}.{bodyHash} - timestamp: Unix timestamp in milliseconds - METHOD: HTTP method in UPPERCASE (GET, POST, etc.) - path: Request path (e.g., /v1/transactions) - bodyHash: SHA256 hex digest of request body (empty string if no body) **Timestamp Tolerance:** ±5 minutes (300 seconds) **Example:** For POST /v1/transactions with body {"amount":100} and timestamp 1234567890000: Payload: 1234567890000.POST./v1/transactions.{sha256(body)} Signature: sha256=abc123... integratorKey: type: apiKey in: header name: X-Integrator-Key description: 'Integrator API key (format: int_...) used with HMAC authentication' timestamp: type: apiKey in: header name: X-Timestamp description: >- Unix timestamp in milliseconds for replay attack prevention. Must be within 5 minutes of server time. ````