Skip to content

PaiementsApi.md

Latest commit

 

History

History
272 lines (200 loc) · 17.8 KB

PaiementsApi.md

File metadata and controls

272 lines (200 loc) · 17.8 KB

HelloAssoApi.PaiementsApi

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

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

organizationsOrganizationSlugFormsFormTypeFormSlugPaymentsGet

HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelPayment organizationsOrganizationSlugFormsFormTypeFormSlugPaymentsGet(organizationSlug, formSlug, formType, opts)

Obtenir les informations des paiements effectués sur un formulaire

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>FormAdmin<br/>OrganizationAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> AccessTransactions<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';
let defaultClient = HelloAssoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
let OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new HelloAssoApi.PaiementsApi();
let organizationSlug = "organizationSlug_example"; // String | The organization slug
let formSlug = "formSlug_example"; // String | The form slug
let formType = new HelloAssoApi.HelloAssoApiV5CommonModelsEnumsFormType(); // HelloAssoApiV5CommonModelsEnumsFormType | The form type CrowdFunding, Membership, Event, Donation, PaymentForm, Checkout, Shop
let opts = {
  'from': new Date("2013-10-20T19:20:30+01:00"), // Date | First Date Filter
  'to': new Date("2013-10-20T19:20:30+01:00"), // Date | End Date Filter (exclusive)
  'userSearchKey': "userSearchKey_example", // String | Filter results on user or payer first name, last name or email
  'pageIndex': 1, // Number | The page of results to retrieve
  'pageSize': 20, // Number | The number of items per page
  'continuationToken': "continuationToken_example", // String | Continuation Token from which we wish to retrieve results
  'states': [new HelloAssoApi.HelloAssoApiV5CommonModelsEnumsPaymentState()], // [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).
  'sortOrder': new HelloAssoApi.HelloAssoApiV5CommonModelsEnumsSortOrder(), // HelloAssoApiV5CommonModelsEnumsSortOrder | Sort payments by ascending or descending order. Default is descending
  'sortField': new HelloAssoApi.HelloAssoApiV5CommonModelsEnumsSortField() // HelloAssoApiV5CommonModelsEnumsSortField | Sort payments by a specific field (Date or UpdateDate). Default is date
};
apiInstance.organizationsOrganizationSlugFormsFormTypeFormSlugPaymentsGet(organizationSlug, formSlug, formType, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationSlug String The organization slug
formSlug String The form slug
formType HelloAssoApiV5CommonModelsEnumsFormType The form type CrowdFunding, Membership, Event, Donation, PaymentForm, Checkout, Shop
from Date First Date Filter [optional]
to Date End Date Filter (exclusive) [optional]
userSearchKey String Filter results on user or payer first name, last name or email [optional]
pageIndex Number The page of results to retrieve [optional] [default to 1]
pageSize Number The number of items per page [optional] [default to 20]
continuationToken String Continuation Token from which we wish to retrieve results [optional]
states [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]
sortOrder HelloAssoApiV5CommonModelsEnumsSortOrder Sort payments by ascending or descending order. Default is descending [optional]
sortField 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

organizationsOrganizationSlugPaymentsGet

HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelPayment organizationsOrganizationSlugPaymentsGet(organizationSlug, opts)

Obtenir les informations des paiements effectués sur une organisation

Retourne la liste des paiements selon les paramètres<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>OrganizationAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> AccessTransactions<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';
let defaultClient = HelloAssoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
let OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new HelloAssoApi.PaiementsApi();
let organizationSlug = "organizationSlug_example"; // String | The organization Slug
let opts = {
  'from': new Date("2013-10-20T19:20:30+01:00"), // Date | First Date Filter
  'to': new Date("2013-10-20T19:20:30+01:00"), // Date | End Date Filter (exclusive)
  'userSearchKey': "userSearchKey_example", // String | Filter results on user or payer first name, last name or email
  'pageIndex': 1, // Number | The page of results to retrieve
  'pageSize': 20, // Number | The number of items per page
  'continuationToken': "continuationToken_example", // String | Continuation Token from which we wish to retrieve results
  'states': [new HelloAssoApi.HelloAssoApiV5CommonModelsEnumsPaymentState()], // [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).
  'sortOrder': new HelloAssoApi.HelloAssoApiV5CommonModelsEnumsSortOrder(), // HelloAssoApiV5CommonModelsEnumsSortOrder | Sort payments by ascending or descending order. Default is descending
  'sortField': new HelloAssoApi.HelloAssoApiV5CommonModelsEnumsSortField() // HelloAssoApiV5CommonModelsEnumsSortField | Sort payments by a specific field (Date or UpdateDate). Default is date
};
apiInstance.organizationsOrganizationSlugPaymentsGet(organizationSlug, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationSlug String The organization Slug
from Date First Date Filter [optional]
to Date End Date Filter (exclusive) [optional]
userSearchKey String Filter results on user or payer first name, last name or email [optional]
pageIndex Number The page of results to retrieve [optional] [default to 1]
pageSize Number The number of items per page [optional] [default to 20]
continuationToken String Continuation Token from which we wish to retrieve results [optional]
states [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]
sortOrder HelloAssoApiV5CommonModelsEnumsSortOrder Sort payments by ascending or descending order. Default is descending [optional]
sortField 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

paymentsPaymentIdGet

HelloAssoApiV5CommonModelsStatisticsPaymentDetail paymentsPaymentIdGet(paymentId, opts)

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

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>FormAdmin<br/>OrganizationAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> AccessTransactions<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';
let defaultClient = HelloAssoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
let OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new HelloAssoApi.PaiementsApi();
let paymentId = 56; // Number | The payment identifier.
let opts = {
  'withFailedRefundOperation': false // Boolean | True to retrieve the refund operation in the states 'ABORTED', 'CANCELED', 'ERROR', 'REFUSED'.
};
apiInstance.paymentsPaymentIdGet(paymentId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
paymentId Number The payment identifier.
withFailedRefundOperation Boolean 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

paymentsPaymentIdRefundPost

HelloAssoApiV5CommonModelsPaymentRefundOperationModel paymentsPaymentIdRefundPost(paymentId, opts)

Rembourser un paiement.

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>OrganizationAdmin<br/>FormAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> RefundManagement<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';
let defaultClient = HelloAssoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
let OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new HelloAssoApi.PaiementsApi();
let paymentId = 56; // Number | The payment identifier.
let opts = {
  'comment': "comment_example", // String | The comment about this refund.
  'cancelOrder': false, // Boolean | Whether the future payments and linked items of this order must be canceled (possible only if the payment is fully refunded)
  'sendRefundMail': true, // Boolean | Whether a refund mail must be sent or not.
  'amount': 0, // Number | 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
  'xMfaAccessAuthorization': "xMfaAccessAuthorization_example", // String | Must be filled only if AuthorizationErrors.MFA.AccessTokenRequired error code was returned previously.
  'xMfaSmsAccessAuthorization': "xMfaSmsAccessAuthorization_example", // String | Must be filled only if AuthorizationErrors.MFA.AccessOtpSmsRequired error code was returned previously.
  'xMfaPasswordAuthorization': "xMfaPasswordAuthorization_example" // String | Must be filled only if AuthorizationErrors.MFA.AccessPasswordTokenRequired error code was returned previously.
};
apiInstance.paymentsPaymentIdRefundPost(paymentId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
paymentId Number The payment identifier.
comment String The comment about this refund. [optional]
cancelOrder Boolean 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]
sendRefundMail Boolean Whether a refund mail must be sent or not. [optional] [default to true]
amount Number 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]
xMfaAccessAuthorization String Must be filled only if AuthorizationErrors.MFA.AccessTokenRequired error code was returned previously. [optional]
xMfaSmsAccessAuthorization String Must be filled only if AuthorizationErrors.MFA.AccessOtpSmsRequired error code was returned previously. [optional]
xMfaPasswordAuthorization String 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