helloasso_python.PaiementsApi

All URIs are relative to https://api.helloasso.com/v5

Method	HTTP request	Description
organizations_organization_slug_forms_form_type_form_slug_payments_get	GET /organizations/{organizationSlug}/forms/{formType}/{formSlug}/payments	Obtenir les informations des paiements effectués sur un formulaire
organizations_organization_slug_payments_get	GET /organizations/{organizationSlug}/payments	Obtenir les informations des paiements effectués sur une organisation
payments_payment_id_get	GET /payments/{paymentId}	Obtenir les informations détaillées d'un paiement.
payments_payment_id_refund_post	POST /payments/{paymentId}/refund	Rembourser un paiement.

organizations_organization_slug_forms_form_type_form_slug_payments_get

HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelPayment organizations_organization_slug_forms_form_type_form_slug_payments_get(organization_slug, form_slug, form_type, var_from=var_from, to=to, user_search_key=user_search_key, page_index=page_index, page_size=page_size, continuation_token=continuation_token, states=states, sort_order=sort_order, sort_field=sort_field)

Obtenir les informations des paiements effectués sur un formulaire

Votre token doit avoir l'un de ces rôles :
FormAdmin
OrganizationAdmin

Si vous êtes une association, vous pouvez obtenir ces rôles avec votre client.
Si vous êtes un partenaire, vous pouvez obtenir ces rôles par le flux d'autorisation.

Votre clientId doit être autorisé à tous ces privilèges :
AccessTransactions

Example

OAuth Authentication (OAuth2):

import helloasso_python
from helloasso_python.models.hello_asso_api_v5_common_models_common_results_with_pagination_model_payment import HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelPayment
from helloasso_python.models.hello_asso_api_v5_common_models_enums_form_type import HelloAssoApiV5CommonModelsEnumsFormType
from helloasso_python.models.hello_asso_api_v5_common_models_enums_payment_state import HelloAssoApiV5CommonModelsEnumsPaymentState
from helloasso_python.models.hello_asso_api_v5_common_models_enums_sort_field import HelloAssoApiV5CommonModelsEnumsSortField
from helloasso_python.models.hello_asso_api_v5_common_models_enums_sort_order import HelloAssoApiV5CommonModelsEnumsSortOrder
from helloasso_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.helloasso.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = helloasso_python.Configuration(
    host = "https://api.helloasso.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with helloasso_python.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = helloasso_python.PaiementsApi(api_client)
    organization_slug = 'organization_slug_example' # str | The organization slug
    form_slug = 'form_slug_example' # str | The form slug
    form_type = helloasso_python.HelloAssoApiV5CommonModelsEnumsFormType() # HelloAssoApiV5CommonModelsEnumsFormType | The form type CrowdFunding, Membership, Event, Donation, PaymentForm, Checkout, Shop
    var_from = '2013-10-20T19:20:30+01:00' # datetime | First Date Filter (optional)
    to = '2013-10-20T19:20:30+01:00' # datetime | End Date Filter (exclusive) (optional)
    user_search_key = 'user_search_key_example' # str | Filter results on user or payer first name, last name or email (optional)
    page_index = 1 # int | The page of results to retrieve (optional) (default to 1)
    page_size = 20 # int | The number of items per page (optional) (default to 20)
    continuation_token = 'continuation_token_example' # str | Continuation Token from which we wish to retrieve results (optional)
    states = [helloasso_python.HelloAssoApiV5CommonModelsEnumsPaymentState()] # List[HelloAssoApiV5CommonModelsEnumsPaymentState] | Filter results by states of payments  Available values: * `Pending` - A payment scheduled at a later date, not yet processed. * `Authorized` - The payment has been authorized, validated, processed. * `Refused` - The payment has been refused by the bank. * `Unknown` * `Registered` - Represents a payment made offline.             Probably for an item of type * `Refunded` - The payment has been refunded. * `Refunding` - The payment is being refunded. * `Contested` - Payment has been contested by the contributor * `WaitingBankValidation` - The payment is pending validation from the bank (used by SEPA direct debit). (optional)
    sort_order = helloasso_python.HelloAssoApiV5CommonModelsEnumsSortOrder() # HelloAssoApiV5CommonModelsEnumsSortOrder | Sort payments by ascending or descending order. Default is descending (optional)
    sort_field = helloasso_python.HelloAssoApiV5CommonModelsEnumsSortField() # HelloAssoApiV5CommonModelsEnumsSortField | Sort payments by a specific field (Date or UpdateDate). Default is date (optional)

    try:
        # Obtenir les informations des paiements effectués sur un formulaire
        api_response = api_instance.organizations_organization_slug_forms_form_type_form_slug_payments_get(organization_slug, form_slug, form_type, var_from=var_from, to=to, user_search_key=user_search_key, page_index=page_index, page_size=page_size, continuation_token=continuation_token, states=states, sort_order=sort_order, sort_field=sort_field)
        print("The response of PaiementsApi->organizations_organization_slug_forms_form_type_form_slug_payments_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaiementsApi->organizations_organization_slug_forms_form_type_form_slug_payments_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_slug	str	The organization slug
form_slug	str	The form slug
form_type	HelloAssoApiV5CommonModelsEnumsFormType	The form type CrowdFunding, Membership, Event, Donation, PaymentForm, Checkout, Shop
var_from	datetime	First Date Filter	[optional]
to	datetime	End Date Filter (exclusive)	[optional]
user_search_key	str	Filter results on user or payer first name, last name or email	[optional]
page_index	int	The page of results to retrieve	[optional] [default to 1]
page_size	int	The number of items per page	[optional] [default to 20]
continuation_token	str	Continuation Token from which we wish to retrieve results	[optional]
states	List[HelloAssoApiV5CommonModelsEnumsPaymentState]	Filter results by states of payments Available values: * `Pending` - A payment scheduled at a later date, not yet processed. * `Authorized` - The payment has been authorized, validated, processed. * `Refused` - The payment has been refused by the bank. * `Unknown` * `Registered` - Represents a payment made offline. Probably for an item of type * `Refunded` - The payment has been refunded. * `Refunding` - The payment is being refunded. * `Contested` - Payment has been contested by the contributor * `WaitingBankValidation` - The payment is pending validation from the bank (used by SEPA direct debit).	[optional]
sort_order	HelloAssoApiV5CommonModelsEnumsSortOrder	Sort payments by ascending or descending order. Default is descending	[optional]
sort_field	HelloAssoApiV5CommonModelsEnumsSortField	Sort payments by a specific field (Date or UpdateDate). Default is date	[optional]

Return type

HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelPayment

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-
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	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

organizations_organization_slug_payments_get

HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelPayment organizations_organization_slug_payments_get(organization_slug, var_from=var_from, to=to, user_search_key=user_search_key, page_index=page_index, page_size=page_size, continuation_token=continuation_token, states=states, sort_order=sort_order, sort_field=sort_field)

Obtenir les informations des paiements effectués sur une organisation

Retourne la liste des paiements selon les paramètres

Votre token doit avoir l'un de ces rôles :
OrganizationAdmin

Si vous êtes une association, vous pouvez obtenir ces rôles avec votre client.
Si vous êtes un partenaire, vous pouvez obtenir ces rôles par le flux d'autorisation.

Votre clientId doit être autorisé à tous ces privilèges :
AccessTransactions

Example

OAuth Authentication (OAuth2):

import helloasso_python
from helloasso_python.models.hello_asso_api_v5_common_models_common_results_with_pagination_model_payment import HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelPayment
from helloasso_python.models.hello_asso_api_v5_common_models_enums_payment_state import HelloAssoApiV5CommonModelsEnumsPaymentState
from helloasso_python.models.hello_asso_api_v5_common_models_enums_sort_field import HelloAssoApiV5CommonModelsEnumsSortField
from helloasso_python.models.hello_asso_api_v5_common_models_enums_sort_order import HelloAssoApiV5CommonModelsEnumsSortOrder
from helloasso_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.helloasso.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = helloasso_python.Configuration(
    host = "https://api.helloasso.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with helloasso_python.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = helloasso_python.PaiementsApi(api_client)
    organization_slug = 'organization_slug_example' # str | The organization Slug
    var_from = '2013-10-20T19:20:30+01:00' # datetime | First Date Filter (optional)
    to = '2013-10-20T19:20:30+01:00' # datetime | End Date Filter (exclusive) (optional)
    user_search_key = 'user_search_key_example' # str | Filter results on user or payer first name, last name or email (optional)
    page_index = 1 # int | The page of results to retrieve (optional) (default to 1)
    page_size = 20 # int | The number of items per page (optional) (default to 20)
    continuation_token = 'continuation_token_example' # str | Continuation Token from which we wish to retrieve results (optional)
    states = [helloasso_python.HelloAssoApiV5CommonModelsEnumsPaymentState()] # List[HelloAssoApiV5CommonModelsEnumsPaymentState] | The payment states  Available values: * `Pending` - A payment scheduled at a later date, not yet processed. * `Authorized` - The payment has been authorized, validated, processed. * `Refused` - The payment has been refused by the bank. * `Unknown` * `Registered` - Represents a payment made offline.             Probably for an item of type * `Refunded` - The payment has been refunded. * `Refunding` - The payment is being refunded. * `Contested` - Payment has been contested by the contributor * `WaitingBankValidation` - The payment is pending validation from the bank (used by SEPA direct debit). (optional)
    sort_order = helloasso_python.HelloAssoApiV5CommonModelsEnumsSortOrder() # HelloAssoApiV5CommonModelsEnumsSortOrder | Sort payments by ascending or descending order. Default is descending (optional)
    sort_field = helloasso_python.HelloAssoApiV5CommonModelsEnumsSortField() # HelloAssoApiV5CommonModelsEnumsSortField | Sort payments by a specific field (Date or UpdateDate). Default is date (optional)

    try:
        # Obtenir les informations des paiements effectués sur une organisation
        api_response = api_instance.organizations_organization_slug_payments_get(organization_slug, var_from=var_from, to=to, user_search_key=user_search_key, page_index=page_index, page_size=page_size, continuation_token=continuation_token, states=states, sort_order=sort_order, sort_field=sort_field)
        print("The response of PaiementsApi->organizations_organization_slug_payments_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaiementsApi->organizations_organization_slug_payments_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_slug	str	The organization Slug
var_from	datetime	First Date Filter	[optional]
to	datetime	End Date Filter (exclusive)	[optional]
user_search_key	str	Filter results on user or payer first name, last name or email	[optional]
page_index	int	The page of results to retrieve	[optional] [default to 1]
page_size	int	The number of items per page	[optional] [default to 20]
continuation_token	str	Continuation Token from which we wish to retrieve results	[optional]
states	List[HelloAssoApiV5CommonModelsEnumsPaymentState]	The payment states Available values: * `Pending` - A payment scheduled at a later date, not yet processed. * `Authorized` - The payment has been authorized, validated, processed. * `Refused` - The payment has been refused by the bank. * `Unknown` * `Registered` - Represents a payment made offline. Probably for an item of type * `Refunded` - The payment has been refunded. * `Refunding` - The payment is being refunded. * `Contested` - Payment has been contested by the contributor * `WaitingBankValidation` - The payment is pending validation from the bank (used by SEPA direct debit).	[optional]
sort_order	HelloAssoApiV5CommonModelsEnumsSortOrder	Sort payments by ascending or descending order. Default is descending	[optional]
sort_field	HelloAssoApiV5CommonModelsEnumsSortField	Sort payments by a specific field (Date or UpdateDate). Default is date	[optional]

Return type

HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelPayment

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, text/csv

HTTP response details

Status code	Description	Response headers
200	Success	-
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	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

payments_payment_id_get

HelloAssoApiV5CommonModelsStatisticsPaymentDetail payments_payment_id_get(payment_id, with_failed_refund_operation=with_failed_refund_operation)

Obtenir les informations détaillées d'un paiement.

Example

OAuth Authentication (OAuth2):

import helloasso_python
from helloasso_python.models.hello_asso_api_v5_common_models_statistics_payment_detail import HelloAssoApiV5CommonModelsStatisticsPaymentDetail
from helloasso_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.helloasso.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = helloasso_python.Configuration(
    host = "https://api.helloasso.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with helloasso_python.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = helloasso_python.PaiementsApi(api_client)
    payment_id = 56 # int | The payment identifier.
    with_failed_refund_operation = False # bool | True to retrieve the refund operation in the states 'ABORTED', 'CANCELED', 'ERROR', 'REFUSED'. (optional) (default to False)

    try:
        # Obtenir les informations détaillées d'un paiement.
        api_response = api_instance.payments_payment_id_get(payment_id, with_failed_refund_operation=with_failed_refund_operation)
        print("The response of PaiementsApi->payments_payment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaiementsApi->payments_payment_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
payment_id	int	The payment identifier.
with_failed_refund_operation	bool	True to retrieve the refund operation in the states 'ABORTED', 'CANCELED', 'ERROR', 'REFUSED'.	[optional] [default to False]

Return type

HelloAssoApiV5CommonModelsStatisticsPaymentDetail

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-
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	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

payments_payment_id_refund_post

HelloAssoApiV5CommonModelsPaymentRefundOperationModel payments_payment_id_refund_post(payment_id, comment=comment, cancel_order=cancel_order, send_refund_mail=send_refund_mail, amount=amount, x_mfa_access_authorization=x_mfa_access_authorization, x_mfa_sms_access_authorization=x_mfa_sms_access_authorization, x_mfa_password_authorization=x_mfa_password_authorization)

Rembourser un paiement.

Votre token doit avoir l'un de ces rôles :
OrganizationAdmin
FormAdmin

Si vous êtes une association, vous pouvez obtenir ces rôles avec votre client.
Si vous êtes un partenaire, vous pouvez obtenir ces rôles par le flux d'autorisation.

Votre clientId doit être autorisé à tous ces privilèges :
RefundManagement

Example

OAuth Authentication (OAuth2):

import helloasso_python
from helloasso_python.models.hello_asso_api_v5_common_models_payment_refund_operation_model import HelloAssoApiV5CommonModelsPaymentRefundOperationModel
from helloasso_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.helloasso.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = helloasso_python.Configuration(
    host = "https://api.helloasso.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with helloasso_python.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = helloasso_python.PaiementsApi(api_client)
    payment_id = 56 # int | The payment identifier.
    comment = 'comment_example' # str | The comment about this refund. (optional)
    cancel_order = False # bool | Whether the future payments and linked items of this order must be canceled (possible only if the payment is fully refunded) (optional) (default to False)
    send_refund_mail = True # bool | Whether a refund mail must be sent or not. (optional) (default to True)
    amount = 0 # int | The amount in cents to refund. Enter this amount only for a partial refund for stripe. If not filled in then the entire payment is refunded (optional) (default to 0)
    x_mfa_access_authorization = 'x_mfa_access_authorization_example' # str | Must be filled only if AuthorizationErrors.MFA.AccessTokenRequired error code was returned previously. (optional)
    x_mfa_sms_access_authorization = 'x_mfa_sms_access_authorization_example' # str | Must be filled only if AuthorizationErrors.MFA.AccessOtpSmsRequired error code was returned previously. (optional)
    x_mfa_password_authorization = 'x_mfa_password_authorization_example' # str | Must be filled only if AuthorizationErrors.MFA.AccessPasswordTokenRequired error code was returned previously. (optional)

    try:
        # Rembourser un paiement.
        api_response = api_instance.payments_payment_id_refund_post(payment_id, comment=comment, cancel_order=cancel_order, send_refund_mail=send_refund_mail, amount=amount, x_mfa_access_authorization=x_mfa_access_authorization, x_mfa_sms_access_authorization=x_mfa_sms_access_authorization, x_mfa_password_authorization=x_mfa_password_authorization)
        print("The response of PaiementsApi->payments_payment_id_refund_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaiementsApi->payments_payment_id_refund_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
payment_id	int	The payment identifier.
comment	str	The comment about this refund.	[optional]
cancel_order	bool	Whether the future payments and linked items of this order must be canceled (possible only if the payment is fully refunded)	[optional] [default to False]
send_refund_mail	bool	Whether a refund mail must be sent or not.	[optional] [default to True]
amount	int	The amount in cents to refund. Enter this amount only for a partial refund for stripe. If not filled in then the entire payment is refunded	[optional] [default to 0]
x_mfa_access_authorization	str	Must be filled only if AuthorizationErrors.MFA.AccessTokenRequired error code was returned previously.	[optional]
x_mfa_sms_access_authorization	str	Must be filled only if AuthorizationErrors.MFA.AccessOtpSmsRequired error code was returned previously.	[optional]
x_mfa_password_authorization	str	Must be filled only if AuthorizationErrors.MFA.AccessPasswordTokenRequired error code was returned previously.	[optional]

Return type

HelloAssoApiV5CommonModelsPaymentRefundOperationModel

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-
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	-
409	### Multi-Factor Authentication Required This endpoint requires MFA. Below are the possible error codes and required headers: --- Code: `AuthorizationErrors.MFA.AccessTokenRequired` MFA token not found <br/><br/> A MFA token is expected in x-mfa-access-authorization header or in cookie mfa-{protectedOperation}-{organizationId}. --- Code: `AuthorizationErrors.MFA.AccessOtpSmsRequired` MFA access otp sms not found <br/><br/> A MFA token is expected in x-mfa-sms-access-authorization header or in cookie mfa-{protectedOperation}-{organizationId}-otp-sms. --- Code: `AuthorizationErrors.MFA.AccessPasswordTokenRequired` MFA access password token not found <br/><br/> A MFA token is expected in x-mfa-password-authorization header or in cookie mfa-{protectedOperation}-{organizationId}-pwd. --- Code: `AuthorizationErrors.UserNotEnrolled` User 123 not enrolled	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

helloasso_python.PaiementsApi

organizations_organization_slug_forms_form_type_form_slug_payments_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

organizations_organization_slug_payments_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

payments_payment_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

payments_payment_id_refund_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

FilesExpand file tree

PaiementsApi.md

Latest commit

History

PaiementsApi.md

File metadata and controls

helloasso_python.PaiementsApi

organizations_organization_slug_forms_form_type_form_slug_payments_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

organizations_organization_slug_payments_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

payments_payment_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

payments_payment_id_refund_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details