List ACH debit returns

curl --request GET \
  --url https://platform.spritz.finance/v1/integrator/ach-debit/returns \
  --header 'X-Integrator-Key: <api-key>' \
  --header 'X-Signature: <api-key>' \
  --header 'X-Timestamp: <api-key>'

import requests

url = "https://platform.spritz.finance/v1/integrator/ach-debit/returns"

headers = {
    "X-Signature": "<api-key>",
    "X-Integrator-Key": "<api-key>",
    "X-Timestamp": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-Signature': '<api-key>',
    'X-Integrator-Key': '<api-key>',
    'X-Timestamp': '<api-key>'
  }
};

fetch('https://platform.spritz.finance/v1/integrator/ach-debit/returns', 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/integrator/ach-debit/returns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Integrator-Key: <api-key>",
    "X-Signature: <api-key>",
    "X-Timestamp: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://platform.spritz.finance/v1/integrator/ach-debit/returns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Signature", "<api-key>")
	req.Header.Add("X-Integrator-Key", "<api-key>")
	req.Header.Add("X-Timestamp", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://platform.spritz.finance/v1/integrator/ach-debit/returns")
  .header("X-Signature", "<api-key>")
  .header("X-Integrator-Key", "<api-key>")
  .header("X-Timestamp", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.spritz.finance/v1/integrator/ach-debit/returns")

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

request = Net::HTTP::Get.new(url)
request["X-Signature"] = '<api-key>'
request["X-Integrator-Key"] = '<api-key>'
request["X-Timestamp"] = '<api-key>'

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

{
  "data": [
    {
      "id": "dr_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
      "depositId": "dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
      "userId": "6a749a054c3b8fc5da595d1c",
      "sourceId": "fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
      "onRampId": "<string>",
      "amountUsd": "<string>",
      "currency": "<string>",
      "returnCode": "<string>",
      "returnReason": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "lossAmountUsd": "<string>",
      "atRiskAmountUsd": "<string>",
      "sourceAction": "disabled"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

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

{
  "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
}

GET

integrator

ach-debit

returns

List ACH debit returns

curl --request GET \
  --url https://platform.spritz.finance/v1/integrator/ach-debit/returns \
  --header 'X-Integrator-Key: <api-key>' \
  --header 'X-Signature: <api-key>' \
  --header 'X-Timestamp: <api-key>'

import requests

url = "https://platform.spritz.finance/v1/integrator/ach-debit/returns"

headers = {
    "X-Signature": "<api-key>",
    "X-Integrator-Key": "<api-key>",
    "X-Timestamp": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-Signature': '<api-key>',
    'X-Integrator-Key': '<api-key>',
    'X-Timestamp': '<api-key>'
  }
};

fetch('https://platform.spritz.finance/v1/integrator/ach-debit/returns', 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/integrator/ach-debit/returns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Integrator-Key: <api-key>",
    "X-Signature: <api-key>",
    "X-Timestamp: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://platform.spritz.finance/v1/integrator/ach-debit/returns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Signature", "<api-key>")
	req.Header.Add("X-Integrator-Key", "<api-key>")
	req.Header.Add("X-Timestamp", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://platform.spritz.finance/v1/integrator/ach-debit/returns")
  .header("X-Signature", "<api-key>")
  .header("X-Integrator-Key", "<api-key>")
  .header("X-Timestamp", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.spritz.finance/v1/integrator/ach-debit/returns")

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

request = Net::HTTP::Get.new(url)
request["X-Signature"] = '<api-key>'
request["X-Integrator-Key"] = '<api-key>'
request["X-Timestamp"] = '<api-key>'

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

{
  "data": [
    {
      "id": "dr_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
      "depositId": "dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
      "userId": "6a749a054c3b8fc5da595d1c",
      "sourceId": "fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X",
      "onRampId": "<string>",
      "amountUsd": "<string>",
      "currency": "<string>",
      "returnCode": "<string>",
      "returnReason": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "lossAmountUsd": "<string>",
      "atRiskAmountUsd": "<string>",
      "sourceAction": "disabled"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

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

{
  "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
}

Authorizations

X-Signature

string

header

required

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...

X-Integrator-Key

string

header

required

Integrator API key (format: int_...) used with HMAC authentication

X-Timestamp

string

header

required

Unix timestamp in milliseconds for replay attack prevention. Must be within 5 minutes of server time.

Query Parameters

limit

number

default:50

Maximum number of results to return

Required range: 1 <= x <= 100

cursor

string

Opaque cursor from the previous response's nextCursor value

userId

string

Filter to one Spritz user ID

Example:

"6a749a054c3b8fc5da595d1b"

userIds

string

Comma-separated Spritz user IDs to include

string

Search by user ID, deposit ID, on-ramp ID, return ID, or return code

returnCode

string

ACH return code

Example:

"R10"

returnBucket

enum<string>

Available options:

unauthorized,

administrative,

other

cryptoStateAtReturn

enum<string>

Available options:

not_released,

in_flight,

partially_confirmed,

fully_confirmed

lossOnly

enum<string>

Available options:

true,

false

userAction

enum<string>

Available options:

none,

review_required,

restricted,

disabled

occurredAfter

string<date-time>

occurredBefore

string<date-time>

Response

Response for status 200

data

object[]

required

Show child attributes

hasMore

boolean

required

Whether there are more results

Example:

true

nextCursor

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

List ACH debit returns

Authorizations

Query Parameters

Response