HEhelloasso
Checkout

Initialisation d'un Checkout

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/>

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

Path parameters

organizationSlugstring required

Request body

totalAmountinteger required

Total amount, all taxes included, in cents (required) Must be equal to the sum of the initial amount and subsequent terms

initialAmountinteger required

The amount for the first term, all taxes included, in cents (required)

itemNamestring 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

backUrlstring required

Url followed by the contributor if he wants to return to its previous site

errorUrlstring required

Url called in case of an error during the checkout process

returnUrlstring required

Url called after the payment

containsDonationboolean required

The sale (or a part of) is a donation

metadataunknown

Response

Success

idinteger

Id of the checkout intent

redirectUrlstring nullable

Url where the contributor must be redirected to

Changes

No recorded changes to this operation across all 1 revision of this API.