Create a direct deposit

curl --request POST \
  --url https://platform.spritz.finance/v1/deposits/direct \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "preparationId": "prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
  "clientContext": {
    "clientIp": "<string>",
    "userAgent": "<string>",
    "sessionId": "<string>",
    "deviceId": "<string>",
    "platform": "<string>",
    "appVersion": "<string>"
  }
}
'

import requests

url = "https://platform.spritz.finance/v1/deposits/direct"

payload = {
    "preparationId": "prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
    "clientContext": {
        "clientIp": "<string>",
        "userAgent": "<string>",
        "sessionId": "<string>",
        "deviceId": "<string>",
        "platform": "<string>",
        "appVersion": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    preparationId: 'prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X',
    clientContext: {
      clientIp: '<string>',
      userAgent: '<string>',
      sessionId: '<string>',
      deviceId: '<string>',
      platform: '<string>',
      appVersion: '<string>'
    }
  })
};

fetch('https://platform.spritz.finance/v1/deposits/direct', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.spritz.finance/v1/deposits/direct",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'preparationId' => 'prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X',
    'clientContext' => [
        'clientIp' => '<string>',
        'userAgent' => '<string>',
        'sessionId' => '<string>',
        'deviceId' => '<string>',
        'platform' => '<string>',
        'appVersion' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.spritz.finance/v1/deposits/direct"

	payload := strings.NewReader("{\n  \"preparationId\": \"prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X\",\n  \"clientContext\": {\n    \"clientIp\": \"<string>\",\n    \"userAgent\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"deviceId\": \"<string>\",\n    \"platform\": \"<string>\",\n    \"appVersion\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.spritz.finance/v1/deposits/direct")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"preparationId\": \"prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X\",\n  \"clientContext\": {\n    \"clientIp\": \"<string>\",\n    \"userAgent\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"deviceId\": \"<string>\",\n    \"platform\": \"<string>\",\n    \"appVersion\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.spritz.finance/v1/deposits/direct")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"preparationId\": \"prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X\",\n  \"clientContext\": {\n    \"clientIp\": \"<string>\",\n    \"userAgent\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"deviceId\": \"<string>\",\n    \"platform\": \"<string>\",\n    \"appVersion\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
  "sourceId": "fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
  "onRampId": "onramp_xyz789",
  "feeRateBps": 123,
  "planAdjustmentBps": 123,
  "integratorTier": "<string>",
  "integratorPlanPhase": "<string>",
  "integratorPolicyVersion": "<string>",
  "principalAmountUsd": "<string>",
  "expectedAssetAmount": "<string>",
  "grossFeeUsd": "<string>",
  "publishedFeeUsd": "<string>",
  "planAdjustmentFeeUsd": "<string>",
  "feeSubsidyUsd": "<string>",
  "userFeeUsd": "<string>",
  "totalDebitAmountUsd": "<string>",
  "feeSubsidy": {
    "percentage": 123,
    "percentageBps": 123,
    "maxAmountUsd": "<string>",
    "appliedAmountUsd": "<string>"
  },
  "asset": "USDC",
  "assetAddress": "<string>",
  "address": "<string>",
  "releasedAmountUsd": "<string>",
  "confirmedReleasedAmountUsd": "<string>",
  "exposureAmountUsd": "<string>",
  "authorizedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "settledAt": "2023-11-07T05:31:56Z",
  "returnedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "returnCode": "<string>",
  "returnReason": "<string>",
  "debitFailureCode": "<string>",
  "debitFailureReason": "<string>",
  "releaseFailureCode": "<string>",
  "releaseFailureReason": "<string>",
  "payoutTxHash": "<string>"
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true,
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "Unauthorized",
  "status": 401,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "Bearer token required",
  "instance": "<string>",
  "realm": "API",
  "scope": "read:users"
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true
}

{
  "title": "<string>",
  "status": 404,
  "resourceType": "user",
  "resourceId": "<string>",
  "type": "about:blank",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true
}

POST

deposits

direct

Create a direct deposit

curl --request POST \
  --url https://platform.spritz.finance/v1/deposits/direct \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "preparationId": "prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
  "clientContext": {
    "clientIp": "<string>",
    "userAgent": "<string>",
    "sessionId": "<string>",
    "deviceId": "<string>",
    "platform": "<string>",
    "appVersion": "<string>"
  }
}
'

import requests

url = "https://platform.spritz.finance/v1/deposits/direct"

payload = {
    "preparationId": "prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
    "clientContext": {
        "clientIp": "<string>",
        "userAgent": "<string>",
        "sessionId": "<string>",
        "deviceId": "<string>",
        "platform": "<string>",
        "appVersion": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    preparationId: 'prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X',
    clientContext: {
      clientIp: '<string>',
      userAgent: '<string>',
      sessionId: '<string>',
      deviceId: '<string>',
      platform: '<string>',
      appVersion: '<string>'
    }
  })
};

fetch('https://platform.spritz.finance/v1/deposits/direct', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.spritz.finance/v1/deposits/direct",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'preparationId' => 'prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X',
    'clientContext' => [
        'clientIp' => '<string>',
        'userAgent' => '<string>',
        'sessionId' => '<string>',
        'deviceId' => '<string>',
        'platform' => '<string>',
        'appVersion' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.spritz.finance/v1/deposits/direct"

	payload := strings.NewReader("{\n  \"preparationId\": \"prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X\",\n  \"clientContext\": {\n    \"clientIp\": \"<string>\",\n    \"userAgent\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"deviceId\": \"<string>\",\n    \"platform\": \"<string>\",\n    \"appVersion\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.spritz.finance/v1/deposits/direct")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"preparationId\": \"prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X\",\n  \"clientContext\": {\n    \"clientIp\": \"<string>\",\n    \"userAgent\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"deviceId\": \"<string>\",\n    \"platform\": \"<string>\",\n    \"appVersion\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.spritz.finance/v1/deposits/direct")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"preparationId\": \"prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X\",\n  \"clientContext\": {\n    \"clientIp\": \"<string>\",\n    \"userAgent\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"deviceId\": \"<string>\",\n    \"platform\": \"<string>\",\n    \"appVersion\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
  "sourceId": "fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
  "onRampId": "onramp_xyz789",
  "feeRateBps": 123,
  "planAdjustmentBps": 123,
  "integratorTier": "<string>",
  "integratorPlanPhase": "<string>",
  "integratorPolicyVersion": "<string>",
  "principalAmountUsd": "<string>",
  "expectedAssetAmount": "<string>",
  "grossFeeUsd": "<string>",
  "publishedFeeUsd": "<string>",
  "planAdjustmentFeeUsd": "<string>",
  "feeSubsidyUsd": "<string>",
  "userFeeUsd": "<string>",
  "totalDebitAmountUsd": "<string>",
  "feeSubsidy": {
    "percentage": 123,
    "percentageBps": 123,
    "maxAmountUsd": "<string>",
    "appliedAmountUsd": "<string>"
  },
  "asset": "USDC",
  "assetAddress": "<string>",
  "address": "<string>",
  "releasedAmountUsd": "<string>",
  "confirmedReleasedAmountUsd": "<string>",
  "exposureAmountUsd": "<string>",
  "authorizedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "settledAt": "2023-11-07T05:31:56Z",
  "returnedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "returnCode": "<string>",
  "returnReason": "<string>",
  "debitFailureCode": "<string>",
  "debitFailureReason": "<string>",
  "releaseFailureCode": "<string>",
  "releaseFailureReason": "<string>",
  "payoutTxHash": "<string>"
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true,
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "title": "Unauthorized",
  "status": 401,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "Bearer token required",
  "instance": "<string>",
  "realm": "API",
  "scope": "read:users"
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true
}

{
  "title": "<string>",
  "status": 404,
  "resourceType": "user",
  "resourceId": "<string>",
  "type": "about:blank",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true
}

{
  "title": "Unauthorized",
  "status": 400,
  "type": "urn:problem-type:auth:unauthorized",
  "detail": "<string>",
  "instance": "/errors/1234567890",
  "code": "transaction_limit",
  "field": "amountUsd",
  "retryable": true
}

Authorizations

Authorization

string

header

required

Cognito JWT token for regular user authentication

Body

preparationId

string

required

Opaque public preparation identifier returned by direct prepare

Example:

"prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X"

clientContext

object

Show child attributes

Response

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

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:

"onramp_xyz789"

status

enum<string>

required

Available options:

authorized,

processing,

partially_released,

completed,

returned,

refunded,

failed

quoteType

enum<string>

required

Available options:

exact_input,

exact_output

priority

enum<string>

required

Available options:

normal,

high

feeRateBps

number

required

planAdjustmentBps

number

required

integratorTier

string | null

required

integratorPlanPhase

string | null

required

integratorPolicyVersion

string | null

required

principalAmountUsd

string

required

expectedAssetAmount

string

required

grossFeeUsd

string

required

publishedFeeUsd

string

required

planAdjustmentFeeUsd

string

required

feeSubsidyUsd

string

required

userFeeUsd

string

required

totalDebitAmountUsd

string

required

feeSubsidy

object | null

required

Show child attributes

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

exposureAmountUsd

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

Auto-Ramp Accounts

Auto-Ramp Addresses

Off-Ramp Quotes

Off-Ramps

On-Ramps

Bank Accounts

Funding Sources

Deposits

Bills

Cards

Debit Cards

Integrator Connect

Integrator

Users

Compliance

Terms

API Keys

Device Authorization

Wallet Kit

Sandbox

Create a direct deposit

Authorizations

Body

Response