Skip to main content
POST
Complete designation-only checkout for an existing donor

Path Parameters

client_id
integer
required

Client id that owns the donor and resulting donations or commitments.

hysform_id
integer
required

Donor HysForm id retained for designation-only checkout context.

designation_id
string
required

Configured designation checkout id from the landing page. Selected gifts are read from Redis rather than this route value.

session_id
string
required

Redis frontend session id containing the checkout cart and, when already logged in, the donor id.

Body

application/json

Existing-donor login and checkout method fields.

login_password
string<password>
required

Donor password. Validator rule: required.

Example:

"secret123"

login_username
string | null

Existing donor username. Validator rule: nullable and exists within the current client.

Example:

"janedonor"

method_login
string | null

Payment method selected by checkout. 3 is treated as card checkout and requires a saved Stripe customer unless the request page is cc.

Example:

"3"

check_number
string | null

Optional check reference. Validator rule: nullable|string|max:100.

Maximum string length: 100
Example:

"1042"

page
string | null

Optional checkout page marker used to bypass saved-card checks when the donor is entering a card.

Example:

"cc"

Response

Checkout donation or commitment was created.

message
string
Example:

"Donation made!"

status
string
Example:

"success"