HelloAsso icon

HelloAsso

Interact with the HelloAsso API

Actions13

Checkout Intent → Create

AI-generated

Summary

Creates a HelloAsso checkout intent for an organization by POSTing to /organizations/{slug}/checkout-intents, returning the API's response, which per the operation description includes the payment redirect URL.

Inputs

  • Organization Slug (required) — Organization identifier from HelloAsso URLs; used in the request path.
  • Total Amount (Cents) (required) — Total amount in cents, taxes included. Must equal the initial amount plus any later terms.
  • Initial Amount (Cents) (required) — Amount of the first term in cents, taxes included.
  • Item Name (required) — Purchase description, 1-250 characters (e.g. "3 tickets").
  • Back URL (required) — URL the contributor is sent to if they leave before paying.
  • Error URL (required) — URL called if checkout fails.
  • Return URL (required) — URL called once payment is completed.
  • Contains Donation — Boolean flag, default false. Marks the sale, or part of it, as a donation.
  • Additional Fields — Optional collection. Currently holds Metadata, free-form JSON (max 20,000 characters) that is returned on the checkout intent.
  • Request Options — Node settings for batching (items per batch, interval), ignoring SSL issues, proxy, and timeout (default 10000 ms).

Output shape

The HelloAsso API JSON response for the created checkout intent, one result per input item. It is not unwrapped, so it comes back as returned by the API.

The source doesn't list the response fields. The operation description says the response includes the payment redirect URL. Requires HelloAsso OAuth2 credentials. The request goes to https://api.helloasso.com/v5/.

Examples

Example 1: Start a payment for 3 event tickets totaling 30 EUR and redirect the buyer to pay.

Organization Slug=my-association, Total Amount=3000, Initial Amount=3000, Item Name="3 tickets", Back/Error/Return URLs set to your site pages. Then use the redirect URL from the output.

Example 2: Attach internal order references to a donation checkout.

Contains Donation=true, Additional Fields > Metadata={"orderRef":"A123"}, plus the required amounts and URLs.

Links

Discussion