---
title: "Initialisation d'un Checkout"
method: POST
path: "/organizations/{organizationSlug}/checkout-intents"
tags: ["Checkout"]
---

# Initialisation d'un Checkout

`POST /organizations/{organizationSlug}/checkout-intents`

## Request

- Base URL: `https://api.helloasso.com/v5`
- URL: `https://api.helloasso.com/v5/organizations/{organizationSlug}/checkout-intents`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.helloasso.com/oauth2/token`

Pour tout savoir sur Checkout consultez d'abord notre <a href="https://dev.helloasso.com/docs/description">documentation</a><br/><br/><b>Votre clientId doit avoir ces autorisations : </b> <br/> Checkout<br/><br/>

## Path parameters

- `organizationSlug` string, required

## Request body

- HelloAssoApiV5CommonModelsCartsInitCheckoutBody
  - `totalAmount` integer, required: Total amount, all taxes included, in cents (required) Must be equal to the sum of the initial amount and subsequent terms
  - `initialAmount` integer, required: The amount for the first term, all taxes included, in cents (required)
  - `itemName` string, required: Item name (required) A text describing what the user paid for ('Renew license', '3 tickets', donation, etc). Will be displayed in the near future in the user space and in the organization back office
  - `backUrl` string, required: Url followed by the contributor if he wants to return to its previous site
  - `errorUrl` string, required: Url called in case of an error during the checkout process
  - `returnUrl` string, required: Url called after the payment
  - `containsDonation` boolean, required: The sale (or a part of) is a donation
  - `terms` HelloAssoApiV5CommonModelsCartsCheckoutTerm[], nullable: The list of future terms (if applicable)
    - `amount` integer, required: Term amount, all taxes included, in cents
    - `date` string, date-time, required: Term date
  - `payer` HelloAssoApiV5CommonModelsCartsCheckoutPayer
    - `firstName` string, nullable: FirstName
    - `lastName` string, nullable: LastName
    - `email` string, nullable: Email
    - `dateOfBirth` string, date-time, nullable: Date of birth (Date only, no time part)
    - `address` string, nullable: Address
    - `city` string, nullable: City
    - `zipCode` string, nullable: ZipCode
    - `country` string, nullable: 3 letter country code
    - `companyName` string, nullable: Used if the payer is a company
  - `metadata` unknown
  - `paymentOptions` HelloAssoApiV5CommonModelsCartsCheckoutPaymentOptions
    - `enableSepa` boolean: Metadata (optional) Whether if this checkout is eligible for SEPA payment

## Response `200`

Success

- HelloAssoApiV5CommonModelsCartsInitCheckoutResponse
  - `id` integer: Id of the checkout intent
  - `redirectUrl` string, nullable: Url where the contributor must be redirected to

## Other responses

- `401`: Unauthorized, you must add a valid JWT into Authorization Header with the format : `Bearer TOKEN`
- `403`: The JWT token hasn't the privileges or Roles for this action

---

[API](https://skmtc.dev/helloasso/apis/helloasso-api.md) - [All operations](https://skmtc.dev/helloasso/apis/helloasso-api/llms.txt) - [OpenAPI document](https://skmtc.dev/helloasso/apis/helloasso-api/revisions/2a79832cb30c?raw)
