Preset Amount Deposit

Overview

A preset amount deposit lets you specify exactly how much the customer will deposit. The customer does not enter an amount — it is locked to the value you set. This is ideal when your platform offers predefined deposit tiers (e.g.

25,

50, $100). Every Soap API request is authenticated with a bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Your API key is in the Soap Dashboard under the Developers section. It looks like key_.... Requests with a missing or invalid API key return 422 — never 401 — with a JSON error field, usually {"error": "API key not found."}. Branch on the status code rather than the message: GET /api/v1/device_pings/latest_geo_check does not yet return the same wording. Never expose your API key in client-side code — it is server-side only.

How It Works

You create a checkout session with type: "deposit" and include fixed_amount_cents.
The customer is redirected to the Soap-hosted checkout page with the amount pre-filled and locked.
The customer selects a payment method and confirms.
Upon completion, a webhook is fired and the customer is redirected back to your app.

API Request

curl -X POST 'https://api-sandbox.paywithsoap.com/api/v1/checkouts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data '{
    "customer_id": "cus_vi57KegYgcRqcGHqip8q6UZiqtrwMT870",
    "type": "deposit",
    "fixed_amount_cents": 10000,
    "experience": "web",
    "return_url": "https://myapp.com/wallet"
}'

Key Parameters

Parameter	Required	Description
`customer_id`	Yes	The customer’s unique identifier
`type`	Yes	Must be `"deposit"`
`fixed_amount_cents`	Yes	The exact deposit amount in cents (e.g. `10000` = $100)
`experience`	No	`"web"`, `"webview"`, or `"iframe"`. Use `"iframe"` when embedding the checkout — see Embedded Checkout.
`return_url`	No	Where to redirect the customer after completion

When to Use

You offer predefined deposit tiers ( $25,$ 50, $100, etc.)
Promotional deposits with a fixed bonus amount
Any scenario where you control the deposit amount

← Back to Create Checkout

View the full API reference for creating checkouts.

API Documentation

API Endpoints

Webhooks

Testing

Preset Amount Deposit

Overview

How It Works

API Request

Key Parameters

When to Use

← Back to Create Checkout

​Overview

​How It Works

​API Request

​Key Parameters

​When to Use

← Back to Create Checkout

Overview

How It Works

API Request

Key Parameters

When to Use