Skip to main content
POST
Cancel a deposit

Authorizations

Authorization
string
header
required

User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.

Path Parameters

depositId
string
required

Opaque public deposit identifier

Example:

"dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X"

Response

An ACH debit deposit authorized by the user and processed asynchronously through debit and crypto release lifecycles.

An ACH debit deposit authorized by the user and processed asynchronously through debit and crypto release lifecycles.

id
string
required

Opaque public deposit identifier

Example:

"dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X"

sourceId
string
required

Opaque public funding source identifier

Example:

"fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X"

onRampId
string | null
required

Identifier of the on-ramp created for this deposit, or null until the on-ramp record exists.

Example:

"6aeeb7b3d7558672d5262d1b"

status
enum<string>
required
Available options:
authorized,
processing,
partially_released,
completed,
returned,
refunded,
failed,
cancelled
quoteType
enum<string>
required
Available options:
exact_input,
exact_output
requestedPriority
enum<string>
required
Available options:
normal,
high
priority
enum<string>
required
Available options:
normal,
high
feeRateBps
number
required
principalAmountUsd
string
required
instantPortionUsd
string
required
instantUnavailableReason
enum<string> | null
required

Why the requested instant portion was dropped entirely, when the person can fix it: bank_relink_required means Spritz could not read the account's balance because the bank connection needs relinking. Remove the bank and link it again to get instant on later deposits. Null when instant was granted, not requested, or dropped for any other reason.

Available options:
bank_relink_required,
null
Example:

null

settlementPortionUsd
string
required
expectedAssetAmount
string
required
grossFeeUsd
string
required
publishedFeeUsd
string
required
regularPublishedFeeUsd
string
required
instantPublishedFeeUsd
string
required
feeSubsidyUsd
string
required
userFeeUsd
string
required
totalDebitAmountUsd
string
required
feeSubsidy
object | null
required
network
enum<string>
required
Available options:
solana,
ethereum,
polygon,
base,
avalanche,
arbitrum
asset
enum<string>
required

Asset sent to the deposit destination

Available options:
USDC
Example:

"USDC"

assetAddress
string
required
address
string
required

Destination wallet address for the crypto release

debitStatus
enum<string>
required
Available options:
authorized,
submitting,
submitted,
settled,
returned,
failed
releaseStatus
enum<string>
required
Available options:
not_started,
queued,
partial,
completed,
failed
releaseDecisionMode
enum<string>
required
Available options:
after_settlement,
early_full,
early_partial
releasedAmountUsd
string
required
confirmedReleasedAmountUsd
string
required
authorizedAt
string<date-time>
required
createdAt
string<date-time>
required
settledAt
string<date-time> | null
required
returnedAt
string<date-time> | null
required
completedAt
string<date-time> | null
required
returnCode
string | null
required
returnReason
string | null
required
debitFailureCode
string | null
required
debitFailureReason
string | null
required
releaseFailureCode
string | null
required
releaseFailureReason
string | null
required
payoutTxHash
string | null
required
cancellable
boolean
required

Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse.

cancellableUntil
string<date-time> | null
required

Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.

cancelledAt
string<date-time> | null
required

When the user's cancellation was confirmed