Skip to main content
POST
Start bank redirect for a campaign donation

Path Parameters

client_id
integer
required

Client id.

Required range: x >= 1
Example:

207

program_id
string
required

Program id. Program route; order/cart methods may accept hyphen-separated program IDs.

Example:

"11"

session_id
string
required

Session id. Frontend or recipient session ID belonging to this organization.

Example:

"checkout-session-from-response"

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

email
string<email>
required

Required for campaign and new signup checkout. Existing donor email requires a verified checkout session before payment.

return_path
string
required

Required app-relative return path: starts with one slash, never //, and contains no backslash.

Required string length: 1 - 2000
Pattern: ^/(?!/)[^\\\\]*$
Example:

"/donate/return"

first_name
string
last_name
string
firstName
string
lastName
string
phone
string
street
string
street2
string
city
string
state
string
zip
string
country
string
organization_name
string
Maximum string length: 255
signup_username
string

Required and unique within the organization when checkout_mode=signup.

Minimum string length: 5
policy_revision
string
type
enum<string>
default:INDIVIDUAL

Organization identity requires organization_name (max 255). Missing type normalizes to INDIVIDUAL.

Available options:
INDIVIDUAL,
ORGANIZATION
custom_fields
object | null

Public donation-field map, at most 100 keys, admitted by donation_field_checkout_v1 and currently visible definitions. Required public fields and select choices are enforced; hidden conditional children are excluded. Text is at most 5000 characters; date values use Y-m-d, numbers are numeric. With the rollout disabled, this map must be empty.

check_number
string | null
Maximum string length: 100
next
string<date>

Optional recurring start date; a valid future date creates a setup-only bank confirmation.

entity_id
integer

Required when no non-empty designations cart is supplied.

amount
number

Single recipient amount; required without donation_amount unless a cart is supplied.

Required range: x >= 0.01
donation_amount
number

Legacy single-recipient amount alias.

Required range: x >= 0.01
frequency
string
default:one time

Single-recipient payment frequency label.

is_custom_amount
boolean
designations
object[]
Minimum array length: 1
additional_gifts
object[] | null
confirmation_token
string | null

Optional Stripe native iDEAL confirmation token for this checkout processor.

Maximum string length: 255
Pattern: ^ctoken_[A-Za-z0-9]+$
Example:

"ctoken_example123"

Response

Start bank redirect for a campaign donation response.

status
enum<string>
Available options:
redirect
checkout_token
string<uuid>
checkout_secret
string

Browser possession secret for disclosing the full result; retain alongside the checkout token.

redirect_url
string<uri> | null

Provider bank redirect, possibly null when already confirmed or no next action is required.

program_id
integer

Present for order checkout. Use this anchor ID when completing/canceling an order with a composite program route.