Skip to main content
POST
Complete checkout for an already logged-in donor

Path Parameters

client_id
integer
required

Client id that owns the donor, program, entity, and resulting donation records.

program_id
integer
required

Program id or program tree id used by Program::getPrograms() when creating sponsorships.

entity_id
integer
required

Entity id the donor is sponsoring or donating to.

session_id
string
required

Redis donor session id. The session must contain logged_in=true and a donor_id for checkout to complete.

Body

application/json
sponsorship_amount
number<float>
required

Donation or sponsorship amount. Validator rule: required|numeric|min:5.

Required range: x >= 5
Example:

35

method
string
required

Payment method code. Validator rule: required; method 3 requires a saved Stripe customer.

Example:

"3"

frequency
integer
required

Frequency code for the entity donation/commitment. Validator rule: required; 5 is treated as one-time in the success message.

Example:

5

check_number
string | null

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

Maximum string length: 100
Example:

"1042"

is_custom_amount
boolean | null

Optional flag passed to sponsorship creation to indicate per-period custom amount behavior.

Example:

false

Response

Checkout completed.

status
string
Example:

"success"

message
string
Example:

"Donation successfully made!"

payment_status
string | null

Payment status recorded by the accepted checkout payment.

Example:

"settled"