> ## 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. # Redeliver a webhook delivery > Sends a webhook delivery again and returns the delivery with `status: "pending"`. The redelivery uses the same `payload`, the same `eventId`, and the same delivery `id` (sent as the `Spritz-Delivery-Id` header), so a handler that deduplicates on `eventId` processes it at most once. Signatures are recomputed at send time with your current webhook secret. It goes to the webhook's current URL and starts a fresh retry schedule (about 24 hours); `attempts` keeps counting from its previous value. Use it after fixing your endpoint for a delivery that ended `failed`. You can also redeliver a `succeeded` or `pending` delivery; a `pending` one is attempted again promptly instead of at its scheduled time. Follow progress with `GET /v1/integrator/webhooks/deliveries`. **Not found** (`404`): `code: "WEBHOOK_DELIVERY_NOT_FOUND"` means no delivery with this ID exists for your integrator. **Conflict** (`409`): `code: "WEBHOOK_NOT_FOUND"` (`retryable: false`) means the webhook this delivery was sent to has been deleted. Create a webhook and reconcile the event from the API instead. ## OpenAPI ````yaml https://platform.spritz.finance/openapi.json post /v1/integrator/webhooks/deliveries/{deliveryId}/redeliver 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: ACH Debit description: ACH debit eligibility and deposit 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/integrator/webhooks/deliveries/{deliveryId}/redeliver: post: tags: - Integrator summary: Redeliver a webhook delivery description: >- Sends a webhook delivery again and returns the delivery with `status: "pending"`. The redelivery uses the same `payload`, the same `eventId`, and the same delivery `id` (sent as the `Spritz-Delivery-Id` header), so a handler that deduplicates on `eventId` processes it at most once. Signatures are recomputed at send time with your current webhook secret. It goes to the webhook's current URL and starts a fresh retry schedule (about 24 hours); `attempts` keeps counting from its previous value. Use it after fixing your endpoint for a delivery that ended `failed`. You can also redeliver a `succeeded` or `pending` delivery; a `pending` one is attempted again promptly instead of at its scheduled time. Follow progress with `GET /v1/integrator/webhooks/deliveries`. **Not found** (`404`): `code: "WEBHOOK_DELIVERY_NOT_FOUND"` means no delivery with this ID exists for your integrator. **Conflict** (`409`): `code: "WEBHOOK_NOT_FOUND"` (`retryable: false`) means the webhook this delivery was sent to has been deleted. Create a webhook and reconcile the event from the API instead. operationId: postV1IntegratorWebhooksDeliveriesByDeliveryIdRedeliver parameters: - name: deliveryId in: path required: true schema: pattern: ^[a-fA-F\d]{24}$ description: >- The delivery `id` from `GET /v1/integrator/webhooks/deliveries` or the `Spritz-Delivery-Id` header type: string responses: '200': description: Response for status 200 content: application/json: schema: type: object properties: id: description: >- Stable delivery ID, sent as the `Spritz-Delivery-Id` header on every attempt and redelivery. Pass it to `POST /v1/integrator/webhooks/deliveries/{deliveryId}/redeliver`. type: string example: 6a7441a013a0c37c0d1facfe eventId: description: >- The `eventId` of the delivered event, the same on every attempt and redelivery. Deduplicate on it. `null` for events sent without one. type: string nullable: true status: default: pending description: >- `pending`: Spritz will retry at `nextAttemptAt`. `succeeded`: your endpoint returned a 2xx (terminal). `failed`: retries are exhausted or your endpoint returned a non-retryable status (terminal); redeliver it once your endpoint is fixed. type: string enum: - pending - succeeded - failed attempts: minimum: 0 description: >- Total HTTP attempts made for this delivery so far, across retries and redeliveries. `null` when not recorded. type: integer nullable: true nextAttemptAt: format: date-time description: >- When Spritz will next attempt this delivery. Set only while `status` is `pending`; otherwise `null`. Not a guarantee of exact timing. type: string nullable: true event: description: The event that was delivered type: string example: onramp.completed webhookUrl: description: The URL the delivery was attempted against type: string example: https://api.example.com/webhooks payload: description: >- The exact body that was sent, and the body the signature was computed over. ACH debit, off-ramp, and credit on-ramp milestone events use the versioned semantic payload variants; other event families use their resource-change payload. anyOf: - description: >- Versioned immutable ACH debit communication payload. `achReturn` is null unless `event` is `achDebit.returned`, when it contains the required return snapshot. anyOf: - type: object properties: schemaVersion: description: >- Version of the immutable ACH communication payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-deposit communication sequence. Reject an event whose sequence is not above the highest accepted sequence for this deposit. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string id: description: >- Opaque public deposit identifier; identical to `deposit.id` type: string example: dep_01K3NQ4QGM7Y5ZP0DRW1M4V8NC deposit: type: object properties: id: description: Opaque public ACH debit deposit identifier type: string example: dep_01K3NQ4QGM7Y5ZP0DRW1M4V8NC asset: description: Asset sent to the deposit destination type: string example: USDC enum: - USDC destinationAddressDisplay: description: >- Shortened destination wallet address for user-facing copy type: string example: 9xQeWv…wM9R principalAmountUsd: type: string totalDebitAmountUsd: type: string confirmedReleasedAmountUsd: type: string debitStatus: type: string enum: - authorized - submitting - submitted - settled - returned - failed description: ACH debit lifecycle state for the deposit example: authorized releaseStatus: type: string enum: - not_started - queued - partial - completed - failed description: >- Crypto release lifecycle state for the deposit example: not_started releaseDecisionMode: type: string enum: - after_settlement - early_full - early_partial description: >- Policy mode used to decide when crypto is released example: after_settlement instantPortionUsd: type: string settlementPortionUsd: type: string userFeeUsd: type: string required: - id - asset - destinationAddressDisplay - principalAmountUsd - totalDebitAmountUsd - confirmedReleasedAmountUsd - debitStatus - releaseStatus - releaseDecisionMode - instantPortionUsd - settlementPortionUsd - userFeeUsd fundingSource: type: object properties: id: description: Opaque public funding source identifier type: string example: fs_01K3NQ4QGM7Y5ZP0DRW1M4V8NC institutionName: type: string nullable: true accountMask: type: string nullable: true required: - id - institutionName - accountMask event: type: string enum: - achDebit.authorized milestone: type: string enum: - authorized achReturn: type: object properties: id: description: Opaque public ACH debit return identifier type: string example: dr_01K3NQ4QGM7Y5ZP0DRW1M4V8NC amountUsd: type: string cryptoStateAtReturn: type: string enum: - not_released - in_flight - partially_confirmed - fully_confirmed description: >- Crypto release state when the ACH return was recorded example: not_released userAction: type: string enum: - none - review_required - restricted - disabled description: >- Action applied to the user after return policy evaluation example: review_required required: - id - amountUsd - cryptoStateAtReturn - userAction nullable: true required: - schemaVersion - eventId - sequence - occurredAt - userId - id - deposit - fundingSource - event - milestone - achReturn - type: object properties: schemaVersion: description: >- Version of the immutable ACH communication payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-deposit communication sequence. Reject an event whose sequence is not above the highest accepted sequence for this deposit. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string id: description: >- Opaque public deposit identifier; identical to `deposit.id` type: string example: dep_01K3NQ4QGM7Y5ZP0DRW1M4V8NC deposit: type: object properties: id: description: Opaque public ACH debit deposit identifier type: string example: dep_01K3NQ4QGM7Y5ZP0DRW1M4V8NC asset: description: Asset sent to the deposit destination type: string example: USDC enum: - USDC destinationAddressDisplay: description: >- Shortened destination wallet address for user-facing copy type: string example: 9xQeWv…wM9R principalAmountUsd: type: string totalDebitAmountUsd: type: string confirmedReleasedAmountUsd: type: string debitStatus: type: string enum: - authorized - submitting - submitted - settled - returned - failed description: ACH debit lifecycle state for the deposit example: authorized releaseStatus: type: string enum: - not_started - queued - partial - completed - failed description: >- Crypto release lifecycle state for the deposit example: not_started releaseDecisionMode: type: string enum: - after_settlement - early_full - early_partial description: >- Policy mode used to decide when crypto is released example: after_settlement instantPortionUsd: type: string settlementPortionUsd: type: string userFeeUsd: type: string required: - id - asset - destinationAddressDisplay - principalAmountUsd - totalDebitAmountUsd - confirmedReleasedAmountUsd - debitStatus - releaseStatus - releaseDecisionMode - instantPortionUsd - settlementPortionUsd - userFeeUsd fundingSource: type: object properties: id: description: Opaque public funding source identifier type: string example: fs_01K3NQ4QGM7Y5ZP0DRW1M4V8NC institutionName: type: string nullable: true accountMask: type: string nullable: true required: - id - institutionName - accountMask event: type: string enum: - achDebit.deliveryProgress milestone: type: string enum: - delivery_progress achReturn: type: object properties: id: description: Opaque public ACH debit return identifier type: string example: dr_01K3NQ4QGM7Y5ZP0DRW1M4V8NC amountUsd: type: string cryptoStateAtReturn: type: string enum: - not_released - in_flight - partially_confirmed - fully_confirmed description: >- Crypto release state when the ACH return was recorded example: not_released userAction: type: string enum: - none - review_required - restricted - disabled description: >- Action applied to the user after return policy evaluation example: review_required required: - id - amountUsd - cryptoStateAtReturn - userAction nullable: true required: - schemaVersion - eventId - sequence - occurredAt - userId - id - deposit - fundingSource - event - milestone - achReturn - type: object properties: schemaVersion: description: >- Version of the immutable ACH communication payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-deposit communication sequence. Reject an event whose sequence is not above the highest accepted sequence for this deposit. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string id: description: >- Opaque public deposit identifier; identical to `deposit.id` type: string example: dep_01K3NQ4QGM7Y5ZP0DRW1M4V8NC deposit: type: object properties: id: description: Opaque public ACH debit deposit identifier type: string example: dep_01K3NQ4QGM7Y5ZP0DRW1M4V8NC asset: description: Asset sent to the deposit destination type: string example: USDC enum: - USDC destinationAddressDisplay: description: >- Shortened destination wallet address for user-facing copy type: string example: 9xQeWv…wM9R principalAmountUsd: type: string totalDebitAmountUsd: type: string confirmedReleasedAmountUsd: type: string debitStatus: type: string enum: - authorized - submitting - submitted - settled - returned - failed description: ACH debit lifecycle state for the deposit example: authorized releaseStatus: type: string enum: - not_started - queued - partial - completed - failed description: >- Crypto release lifecycle state for the deposit example: not_started releaseDecisionMode: type: string enum: - after_settlement - early_full - early_partial description: >- Policy mode used to decide when crypto is released example: after_settlement instantPortionUsd: type: string settlementPortionUsd: type: string userFeeUsd: type: string required: - id - asset - destinationAddressDisplay - principalAmountUsd - totalDebitAmountUsd - confirmedReleasedAmountUsd - debitStatus - releaseStatus - releaseDecisionMode - instantPortionUsd - settlementPortionUsd - userFeeUsd fundingSource: type: object properties: id: description: Opaque public funding source identifier type: string example: fs_01K3NQ4QGM7Y5ZP0DRW1M4V8NC institutionName: type: string nullable: true accountMask: type: string nullable: true required: - id - institutionName - accountMask event: type: string enum: - achDebit.delivered milestone: type: string enum: - delivered achReturn: type: object properties: id: description: Opaque public ACH debit return identifier type: string example: dr_01K3NQ4QGM7Y5ZP0DRW1M4V8NC amountUsd: type: string cryptoStateAtReturn: type: string enum: - not_released - in_flight - partially_confirmed - fully_confirmed description: >- Crypto release state when the ACH return was recorded example: not_released userAction: type: string enum: - none - review_required - restricted - disabled description: >- Action applied to the user after return policy evaluation example: review_required required: - id - amountUsd - cryptoStateAtReturn - userAction nullable: true required: - schemaVersion - eventId - sequence - occurredAt - userId - id - deposit - fundingSource - event - milestone - achReturn - type: object properties: schemaVersion: description: >- Version of the immutable ACH communication payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-deposit communication sequence. Reject an event whose sequence is not above the highest accepted sequence for this deposit. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string id: description: >- Opaque public deposit identifier; identical to `deposit.id` type: string example: dep_01K3NQ4QGM7Y5ZP0DRW1M4V8NC deposit: type: object properties: id: description: Opaque public ACH debit deposit identifier type: string example: dep_01K3NQ4QGM7Y5ZP0DRW1M4V8NC asset: description: Asset sent to the deposit destination type: string example: USDC enum: - USDC destinationAddressDisplay: description: >- Shortened destination wallet address for user-facing copy type: string example: 9xQeWv…wM9R principalAmountUsd: type: string totalDebitAmountUsd: type: string confirmedReleasedAmountUsd: type: string debitStatus: type: string enum: - authorized - submitting - submitted - settled - returned - failed description: ACH debit lifecycle state for the deposit example: authorized releaseStatus: type: string enum: - not_started - queued - partial - completed - failed description: >- Crypto release lifecycle state for the deposit example: not_started releaseDecisionMode: type: string enum: - after_settlement - early_full - early_partial description: >- Policy mode used to decide when crypto is released example: after_settlement instantPortionUsd: type: string settlementPortionUsd: type: string userFeeUsd: type: string required: - id - asset - destinationAddressDisplay - principalAmountUsd - totalDebitAmountUsd - confirmedReleasedAmountUsd - debitStatus - releaseStatus - releaseDecisionMode - instantPortionUsd - settlementPortionUsd - userFeeUsd fundingSource: type: object properties: id: description: Opaque public funding source identifier type: string example: fs_01K3NQ4QGM7Y5ZP0DRW1M4V8NC institutionName: type: string nullable: true accountMask: type: string nullable: true required: - id - institutionName - accountMask event: type: string enum: - achDebit.refunded milestone: type: string enum: - refunded achReturn: type: object properties: id: description: Opaque public ACH debit return identifier type: string example: dr_01K3NQ4QGM7Y5ZP0DRW1M4V8NC amountUsd: type: string cryptoStateAtReturn: type: string enum: - not_released - in_flight - partially_confirmed - fully_confirmed description: >- Crypto release state when the ACH return was recorded example: not_released userAction: type: string enum: - none - review_required - restricted - disabled description: >- Action applied to the user after return policy evaluation example: review_required required: - id - amountUsd - cryptoStateAtReturn - userAction nullable: true required: - schemaVersion - eventId - sequence - occurredAt - userId - id - deposit - fundingSource - event - milestone - achReturn - type: object properties: schemaVersion: description: >- Version of the immutable ACH communication payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-deposit communication sequence. Reject an event whose sequence is not above the highest accepted sequence for this deposit. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string id: description: >- Opaque public deposit identifier; identical to `deposit.id` type: string example: dep_01K3NQ4QGM7Y5ZP0DRW1M4V8NC deposit: type: object properties: id: description: Opaque public ACH debit deposit identifier type: string example: dep_01K3NQ4QGM7Y5ZP0DRW1M4V8NC asset: description: Asset sent to the deposit destination type: string example: USDC enum: - USDC destinationAddressDisplay: description: >- Shortened destination wallet address for user-facing copy type: string example: 9xQeWv…wM9R principalAmountUsd: type: string totalDebitAmountUsd: type: string confirmedReleasedAmountUsd: type: string debitStatus: type: string enum: - authorized - submitting - submitted - settled - returned - failed description: ACH debit lifecycle state for the deposit example: authorized releaseStatus: type: string enum: - not_started - queued - partial - completed - failed description: >- Crypto release lifecycle state for the deposit example: not_started releaseDecisionMode: type: string enum: - after_settlement - early_full - early_partial description: >- Policy mode used to decide when crypto is released example: after_settlement instantPortionUsd: type: string settlementPortionUsd: type: string userFeeUsd: type: string required: - id - asset - destinationAddressDisplay - principalAmountUsd - totalDebitAmountUsd - confirmedReleasedAmountUsd - debitStatus - releaseStatus - releaseDecisionMode - instantPortionUsd - settlementPortionUsd - userFeeUsd fundingSource: type: object properties: id: description: Opaque public funding source identifier type: string example: fs_01K3NQ4QGM7Y5ZP0DRW1M4V8NC institutionName: type: string nullable: true accountMask: type: string nullable: true required: - id - institutionName - accountMask event: type: string enum: - achDebit.returned milestone: type: string enum: - returned achReturn: type: object properties: id: description: Opaque public ACH debit return identifier type: string example: dr_01K3NQ4QGM7Y5ZP0DRW1M4V8NC amountUsd: type: string cryptoStateAtReturn: type: string enum: - not_released - in_flight - partially_confirmed - fully_confirmed description: >- Crypto release state when the ACH return was recorded example: not_released userAction: type: string enum: - none - review_required - restricted - disabled description: >- Action applied to the user after return policy evaluation example: review_required required: - id - amountUsd - cryptoStateAtReturn - userAction required: - schemaVersion - eventId - sequence - occurredAt - userId - id - deposit - fundingSource - event - milestone - achReturn - description: >- Versioned immutable off-ramp milestone payload. `confirmed` = crypto payment confirmed on-chain; `in_flight` = payout submitted to the banking rail; `completed` = fiat delivered; `failed` = a leg failed terminally; `refunded` = funds returned; `reversed` = a settled payout was clawed back. anyOf: - type: object properties: schemaVersion: description: >- Version of the immutable off-ramp milestone payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-off-ramp milestone sequence. Reject an event whose sequence is not above the highest accepted sequence for this off-ramp. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string integratorId: type: string nullable: true id: description: >- The off-ramp identifier; identical to `offRamp.id` type: string offRamp: type: object properties: id: description: The off-ramp identifier type: string quoteId: description: >- The quote (crypto leg) this off-ramp fulfills. Null for auto-ramp-address deposits, which have no quote. type: string nullable: true status: type: string enum: - awaiting_funding - queued - in_flight - completed - canceled - failed - reversed - refunded description: >- Current status of the off-ramp payment. - `awaiting_funding`: Payment initialized, awaiting user funding - `queued`: Payment scheduled for disbursement - `in_flight`: Payment sent, pending settlement - `completed`: Payment delivered to the recipient - `canceled`: Payment canceled - `failed`: Payment failed - `reversed`: Payment reversed - `refunded`: Payment refunded example: in_flight input: type: object properties: amount: description: Crypto amount sent, decimal string type: string token: type: string chain: type: string required: - amount - token - chain nullable: true output: type: object properties: amount: description: Fiat amount, decimal string type: string currency: type: string rail: type: string nullable: true accountId: type: string accountName: type: string nullable: true required: - amount - currency - rail - accountId - accountName fees: type: object properties: amount: type: string currency: type: string required: - amount - currency nullable: true transaction: type: object properties: hash: type: string nullable: true explorerUrl: type: string nullable: true required: - hash - explorerUrl nullable: true failureMessage: description: >- Public-safe failure summary when the milestone is `failed`; never internal or provider detail. type: string nullable: true required: - id - quoteId - status - input - output - fees - transaction - failureMessage event: type: string enum: - offramp.confirmed milestone: type: string enum: - confirmed required: - schemaVersion - eventId - sequence - occurredAt - userId - integratorId - id - offRamp - event - milestone - type: object properties: schemaVersion: description: >- Version of the immutable off-ramp milestone payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-off-ramp milestone sequence. Reject an event whose sequence is not above the highest accepted sequence for this off-ramp. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string integratorId: type: string nullable: true id: description: >- The off-ramp identifier; identical to `offRamp.id` type: string offRamp: type: object properties: id: description: The off-ramp identifier type: string quoteId: description: >- The quote (crypto leg) this off-ramp fulfills. Null for auto-ramp-address deposits, which have no quote. type: string nullable: true status: type: string enum: - awaiting_funding - queued - in_flight - completed - canceled - failed - reversed - refunded description: >- Current status of the off-ramp payment. - `awaiting_funding`: Payment initialized, awaiting user funding - `queued`: Payment scheduled for disbursement - `in_flight`: Payment sent, pending settlement - `completed`: Payment delivered to the recipient - `canceled`: Payment canceled - `failed`: Payment failed - `reversed`: Payment reversed - `refunded`: Payment refunded example: in_flight input: type: object properties: amount: description: Crypto amount sent, decimal string type: string token: type: string chain: type: string required: - amount - token - chain nullable: true output: type: object properties: amount: description: Fiat amount, decimal string type: string currency: type: string rail: type: string nullable: true accountId: type: string accountName: type: string nullable: true required: - amount - currency - rail - accountId - accountName fees: type: object properties: amount: type: string currency: type: string required: - amount - currency nullable: true transaction: type: object properties: hash: type: string nullable: true explorerUrl: type: string nullable: true required: - hash - explorerUrl nullable: true failureMessage: description: >- Public-safe failure summary when the milestone is `failed`; never internal or provider detail. type: string nullable: true required: - id - quoteId - status - input - output - fees - transaction - failureMessage event: type: string enum: - offramp.inFlight milestone: type: string enum: - in_flight required: - schemaVersion - eventId - sequence - occurredAt - userId - integratorId - id - offRamp - event - milestone - type: object properties: schemaVersion: description: >- Version of the immutable off-ramp milestone payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-off-ramp milestone sequence. Reject an event whose sequence is not above the highest accepted sequence for this off-ramp. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string integratorId: type: string nullable: true id: description: >- The off-ramp identifier; identical to `offRamp.id` type: string offRamp: type: object properties: id: description: The off-ramp identifier type: string quoteId: description: >- The quote (crypto leg) this off-ramp fulfills. Null for auto-ramp-address deposits, which have no quote. type: string nullable: true status: type: string enum: - awaiting_funding - queued - in_flight - completed - canceled - failed - reversed - refunded description: >- Current status of the off-ramp payment. - `awaiting_funding`: Payment initialized, awaiting user funding - `queued`: Payment scheduled for disbursement - `in_flight`: Payment sent, pending settlement - `completed`: Payment delivered to the recipient - `canceled`: Payment canceled - `failed`: Payment failed - `reversed`: Payment reversed - `refunded`: Payment refunded example: in_flight input: type: object properties: amount: description: Crypto amount sent, decimal string type: string token: type: string chain: type: string required: - amount - token - chain nullable: true output: type: object properties: amount: description: Fiat amount, decimal string type: string currency: type: string rail: type: string nullable: true accountId: type: string accountName: type: string nullable: true required: - amount - currency - rail - accountId - accountName fees: type: object properties: amount: type: string currency: type: string required: - amount - currency nullable: true transaction: type: object properties: hash: type: string nullable: true explorerUrl: type: string nullable: true required: - hash - explorerUrl nullable: true failureMessage: description: >- Public-safe failure summary when the milestone is `failed`; never internal or provider detail. type: string nullable: true required: - id - quoteId - status - input - output - fees - transaction - failureMessage event: type: string enum: - offramp.completed milestone: type: string enum: - completed required: - schemaVersion - eventId - sequence - occurredAt - userId - integratorId - id - offRamp - event - milestone - type: object properties: schemaVersion: description: >- Version of the immutable off-ramp milestone payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-off-ramp milestone sequence. Reject an event whose sequence is not above the highest accepted sequence for this off-ramp. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string integratorId: type: string nullable: true id: description: >- The off-ramp identifier; identical to `offRamp.id` type: string offRamp: type: object properties: id: description: The off-ramp identifier type: string quoteId: description: >- The quote (crypto leg) this off-ramp fulfills. Null for auto-ramp-address deposits, which have no quote. type: string nullable: true status: type: string enum: - awaiting_funding - queued - in_flight - completed - canceled - failed - reversed - refunded description: >- Current status of the off-ramp payment. - `awaiting_funding`: Payment initialized, awaiting user funding - `queued`: Payment scheduled for disbursement - `in_flight`: Payment sent, pending settlement - `completed`: Payment delivered to the recipient - `canceled`: Payment canceled - `failed`: Payment failed - `reversed`: Payment reversed - `refunded`: Payment refunded example: in_flight input: type: object properties: amount: description: Crypto amount sent, decimal string type: string token: type: string chain: type: string required: - amount - token - chain nullable: true output: type: object properties: amount: description: Fiat amount, decimal string type: string currency: type: string rail: type: string nullable: true accountId: type: string accountName: type: string nullable: true required: - amount - currency - rail - accountId - accountName fees: type: object properties: amount: type: string currency: type: string required: - amount - currency nullable: true transaction: type: object properties: hash: type: string nullable: true explorerUrl: type: string nullable: true required: - hash - explorerUrl nullable: true failureMessage: description: >- Public-safe failure summary when the milestone is `failed`; never internal or provider detail. type: string nullable: true required: - id - quoteId - status - input - output - fees - transaction - failureMessage event: type: string enum: - offramp.failed milestone: type: string enum: - failed required: - schemaVersion - eventId - sequence - occurredAt - userId - integratorId - id - offRamp - event - milestone - type: object properties: schemaVersion: description: >- Version of the immutable off-ramp milestone payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-off-ramp milestone sequence. Reject an event whose sequence is not above the highest accepted sequence for this off-ramp. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string integratorId: type: string nullable: true id: description: >- The off-ramp identifier; identical to `offRamp.id` type: string offRamp: type: object properties: id: description: The off-ramp identifier type: string quoteId: description: >- The quote (crypto leg) this off-ramp fulfills. Null for auto-ramp-address deposits, which have no quote. type: string nullable: true status: type: string enum: - awaiting_funding - queued - in_flight - completed - canceled - failed - reversed - refunded description: >- Current status of the off-ramp payment. - `awaiting_funding`: Payment initialized, awaiting user funding - `queued`: Payment scheduled for disbursement - `in_flight`: Payment sent, pending settlement - `completed`: Payment delivered to the recipient - `canceled`: Payment canceled - `failed`: Payment failed - `reversed`: Payment reversed - `refunded`: Payment refunded example: in_flight input: type: object properties: amount: description: Crypto amount sent, decimal string type: string token: type: string chain: type: string required: - amount - token - chain nullable: true output: type: object properties: amount: description: Fiat amount, decimal string type: string currency: type: string rail: type: string nullable: true accountId: type: string accountName: type: string nullable: true required: - amount - currency - rail - accountId - accountName fees: type: object properties: amount: type: string currency: type: string required: - amount - currency nullable: true transaction: type: object properties: hash: type: string nullable: true explorerUrl: type: string nullable: true required: - hash - explorerUrl nullable: true failureMessage: description: >- Public-safe failure summary when the milestone is `failed`; never internal or provider detail. type: string nullable: true required: - id - quoteId - status - input - output - fees - transaction - failureMessage event: type: string enum: - offramp.refunded milestone: type: string enum: - refunded required: - schemaVersion - eventId - sequence - occurredAt - userId - integratorId - id - offRamp - event - milestone - type: object properties: schemaVersion: description: >- Version of the immutable off-ramp milestone payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-off-ramp milestone sequence. Reject an event whose sequence is not above the highest accepted sequence for this off-ramp. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string integratorId: type: string nullable: true id: description: >- The off-ramp identifier; identical to `offRamp.id` type: string offRamp: type: object properties: id: description: The off-ramp identifier type: string quoteId: description: >- The quote (crypto leg) this off-ramp fulfills. Null for auto-ramp-address deposits, which have no quote. type: string nullable: true status: type: string enum: - awaiting_funding - queued - in_flight - completed - canceled - failed - reversed - refunded description: >- Current status of the off-ramp payment. - `awaiting_funding`: Payment initialized, awaiting user funding - `queued`: Payment scheduled for disbursement - `in_flight`: Payment sent, pending settlement - `completed`: Payment delivered to the recipient - `canceled`: Payment canceled - `failed`: Payment failed - `reversed`: Payment reversed - `refunded`: Payment refunded example: in_flight input: type: object properties: amount: description: Crypto amount sent, decimal string type: string token: type: string chain: type: string required: - amount - token - chain nullable: true output: type: object properties: amount: description: Fiat amount, decimal string type: string currency: type: string rail: type: string nullable: true accountId: type: string accountName: type: string nullable: true required: - amount - currency - rail - accountId - accountName fees: type: object properties: amount: type: string currency: type: string required: - amount - currency nullable: true transaction: type: object properties: hash: type: string nullable: true explorerUrl: type: string nullable: true required: - hash - explorerUrl nullable: true failureMessage: description: >- Public-safe failure summary when the milestone is `failed`; never internal or provider detail. type: string nullable: true required: - id - quoteId - status - input - output - fees - transaction - failureMessage event: type: string enum: - offramp.reversed milestone: type: string enum: - reversed required: - schemaVersion - eventId - sequence - occurredAt - userId - integratorId - id - offRamp - event - milestone - description: >- Versioned immutable credit on-ramp milestone payload (auto-ramp account funding). `deposit_detected` = fiat arrived at the virtual account; `completed` = crypto delivered; `failed` = conversion failed; `reversed`/`refunded` = the fiat deposit was clawed back or returned. anyOf: - type: object properties: schemaVersion: description: >- Version of the immutable credit on-ramp milestone payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-on-ramp milestone sequence. Reject an event whose sequence is not above the highest accepted sequence for this on-ramp. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string integratorId: type: string nullable: true id: description: >- The on-ramp identifier; identical to `onRamp.id` type: string onRamp: type: object properties: id: description: The on-ramp identifier type: string status: description: Public on-ramp status at the milestone type: string input: type: object properties: amount: description: Fiat amount received, decimal string type: string currency: type: string rail: type: string nullable: true required: - amount - currency - rail output: type: object properties: amount: description: Crypto amount delivered or expected type: string token: type: string network: type: string address: description: >- Destination wallet address (the user's own) type: string required: - amount - token - network - address fees: type: object properties: amount: type: string currency: type: string required: - amount - currency nullable: true transaction: type: object properties: hash: type: string nullable: true explorerUrl: type: string nullable: true required: - hash - explorerUrl nullable: true required: - id - status - input - output - fees - transaction event: type: string enum: - onrampCredit.depositDetected milestone: type: string enum: - deposit_detected required: - schemaVersion - eventId - sequence - occurredAt - userId - integratorId - id - onRamp - event - milestone - type: object properties: schemaVersion: description: >- Version of the immutable credit on-ramp milestone payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-on-ramp milestone sequence. Reject an event whose sequence is not above the highest accepted sequence for this on-ramp. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string integratorId: type: string nullable: true id: description: >- The on-ramp identifier; identical to `onRamp.id` type: string onRamp: type: object properties: id: description: The on-ramp identifier type: string status: description: Public on-ramp status at the milestone type: string input: type: object properties: amount: description: Fiat amount received, decimal string type: string currency: type: string rail: type: string nullable: true required: - amount - currency - rail output: type: object properties: amount: description: Crypto amount delivered or expected type: string token: type: string network: type: string address: description: >- Destination wallet address (the user's own) type: string required: - amount - token - network - address fees: type: object properties: amount: type: string currency: type: string required: - amount - currency nullable: true transaction: type: object properties: hash: type: string nullable: true explorerUrl: type: string nullable: true required: - hash - explorerUrl nullable: true required: - id - status - input - output - fees - transaction event: type: string enum: - onrampCredit.completed milestone: type: string enum: - completed required: - schemaVersion - eventId - sequence - occurredAt - userId - integratorId - id - onRamp - event - milestone - type: object properties: schemaVersion: description: >- Version of the immutable credit on-ramp milestone payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-on-ramp milestone sequence. Reject an event whose sequence is not above the highest accepted sequence for this on-ramp. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string integratorId: type: string nullable: true id: description: >- The on-ramp identifier; identical to `onRamp.id` type: string onRamp: type: object properties: id: description: The on-ramp identifier type: string status: description: Public on-ramp status at the milestone type: string input: type: object properties: amount: description: Fiat amount received, decimal string type: string currency: type: string rail: type: string nullable: true required: - amount - currency - rail output: type: object properties: amount: description: Crypto amount delivered or expected type: string token: type: string network: type: string address: description: >- Destination wallet address (the user's own) type: string required: - amount - token - network - address fees: type: object properties: amount: type: string currency: type: string required: - amount - currency nullable: true transaction: type: object properties: hash: type: string nullable: true explorerUrl: type: string nullable: true required: - hash - explorerUrl nullable: true required: - id - status - input - output - fees - transaction event: type: string enum: - onrampCredit.failed milestone: type: string enum: - failed required: - schemaVersion - eventId - sequence - occurredAt - userId - integratorId - id - onRamp - event - milestone - type: object properties: schemaVersion: description: >- Version of the immutable credit on-ramp milestone payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-on-ramp milestone sequence. Reject an event whose sequence is not above the highest accepted sequence for this on-ramp. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string integratorId: type: string nullable: true id: description: >- The on-ramp identifier; identical to `onRamp.id` type: string onRamp: type: object properties: id: description: The on-ramp identifier type: string status: description: Public on-ramp status at the milestone type: string input: type: object properties: amount: description: Fiat amount received, decimal string type: string currency: type: string rail: type: string nullable: true required: - amount - currency - rail output: type: object properties: amount: description: Crypto amount delivered or expected type: string token: type: string network: type: string address: description: >- Destination wallet address (the user's own) type: string required: - amount - token - network - address fees: type: object properties: amount: type: string currency: type: string required: - amount - currency nullable: true transaction: type: object properties: hash: type: string nullable: true explorerUrl: type: string nullable: true required: - hash - explorerUrl nullable: true required: - id - status - input - output - fees - transaction event: type: string enum: - onrampCredit.reversed milestone: type: string enum: - reversed required: - schemaVersion - eventId - sequence - occurredAt - userId - integratorId - id - onRamp - event - milestone - type: object properties: schemaVersion: description: >- Version of the immutable credit on-ramp milestone payload type: string enum: - '1' eventId: description: >- Stable notification-occurrence identifier. Unchanged across delivery retries and replays. type: string sequence: description: >- Per-on-ramp milestone sequence. Reject an event whose sequence is not above the highest accepted sequence for this on-ramp. minimum: 1 type: integer occurredAt: format: date-time type: string userId: type: string integratorId: type: string nullable: true id: description: >- The on-ramp identifier; identical to `onRamp.id` type: string onRamp: type: object properties: id: description: The on-ramp identifier type: string status: description: Public on-ramp status at the milestone type: string input: type: object properties: amount: description: Fiat amount received, decimal string type: string currency: type: string rail: type: string nullable: true required: - amount - currency - rail output: type: object properties: amount: description: Crypto amount delivered or expected type: string token: type: string network: type: string address: description: >- Destination wallet address (the user's own) type: string required: - amount - token - network - address fees: type: object properties: amount: type: string currency: type: string required: - amount - currency nullable: true transaction: type: object properties: hash: type: string nullable: true explorerUrl: type: string nullable: true required: - hash - explorerUrl nullable: true required: - id - status - input - output - fees - transaction event: type: string enum: - onrampCredit.refunded milestone: type: string enum: - refunded required: - schemaVersion - eventId - sequence - occurredAt - userId - integratorId - id - onRamp - event - milestone - type: object additionalProperties: {} success: description: >- Whether Spritz received a successful response. `false` alongside an `error` does not mean your endpoint rejected the event — it may have processed it and only the response was lost. `false` with neither `error` nor `responseStatus` means the outcome was never recorded, not that it failed. Read those two fields before concluding anything about delivery. type: boolean example: true responseStatus: description: >- HTTP status your endpoint returned — but only when `error` is absent. When `error` is set no response was received at all, and this is Spritz's classification of the failure (504 for a timeout, 500 otherwise) rather than anything your endpoint said. type: number example: 200 error: description: >- Set when no usable response was received — a timeout, a refused connection, a DNS or certificate problem. This does **not** prove the request never arrived: a refused connection means it did not, but a timeout or a dropped connection may mean your endpoint received and fully processed it and we never heard back. Treat delivery as unknown and rely on idempotent handling. When `error` is absent the request landed and `responseStatus` is your endpoint's own answer. type: string example: getaddrinfo ENOTFOUND webhooks.example.com timestamp: description: >- When the delivery was attempted. Absent on a handful of very early records that predate the field — omitted rather than guessed. format: date-time type: string required: - id - eventId - status - attempts - nextAttemptAt - event - webhookUrl - payload - success '400': description: Response for status 400 content: application/problem+json: schema: additionalProperties: true 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 retryAfter: description: >- Seconds to wait before retrying, present alongside `retryable: true`. Mirrors the `Retry-After` response header and is meant for short backoffs the server chose (load shedding); for a condition that clears on its own schedule, `clearsAt` carries the absolute time instead. type: number example: 5 suggestedAction: type: string enum: - auto_ramp - wait_for_settlement clearsAt: format: date-time type: string description: >- Earliest known time the current temporary condition may clear. nullable: true availableAt: format: date-time type: string description: >- When a temporarily ineligible funding source may become available again. nullable: true permanent: description: >- Whether the current funding-source restriction will not clear automatically. type: boolean required: - title - status '401': description: Response for status 401 content: application/problem+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/problem+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 '409': description: Response for status 409 content: application/problem+json: schema: additionalProperties: true 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 retryAfter: description: >- Seconds to wait before retrying, present alongside `retryable: true`. Mirrors the `Retry-After` response header and is meant for short backoffs the server chose (load shedding); for a condition that clears on its own schedule, `clearsAt` carries the absolute time instead. type: number example: 5 suggestedAction: type: string enum: - auto_ramp - wait_for_settlement clearsAt: format: date-time type: string description: >- Earliest known time the current temporary condition may clear. nullable: true availableAt: format: date-time type: string description: >- When a temporarily ineligible funding source may become available again. nullable: true permanent: description: >- Whether the current funding-source restriction will not clear automatically. type: boolean required: - title - status '500': description: Response for status 500 content: application/problem+json: schema: additionalProperties: true 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 retryAfter: description: >- Seconds to wait before retrying, present alongside `retryable: true`. Mirrors the `Retry-After` response header and is meant for short backoffs the server chose (load shedding); for a condition that clears on its own schedule, `clearsAt` carries the absolute time instead. type: number example: 5 suggestedAction: type: string enum: - auto_ramp - wait_for_settlement clearsAt: format: date-time type: string description: >- Earliest known time the current temporary condition may clear. nullable: true availableAt: format: date-time type: string description: >- When a temporarily ineligible funding source may become available again. nullable: true permanent: description: >- Whether the current funding-source restriction will not clear automatically. type: boolean required: - title - status security: - hmacAuth: [] integratorKey: [] timestamp: [] components: securitySchemes: hmacAuth: type: apiKey in: header name: X-Signature description: >- HMAC signature authentication for backend integrators. **Required Headers:** - X-Integrator-Key: Integrator API key (format: ik_...) - 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: ik_...) used with HMAC authentication' timestamp: type: apiKey in: header name: X-Timestamp description: >- Unix timestamp in milliseconds for request freshness. Must be within 5 minutes of server time. The timestamp alone bounds but does not prevent an exact replay within that window. Use Idempotency-Key on supported mutations. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.