Sign in

v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB
Paiements

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

get/organizations/{organizationSlug}/forms/{formType}/{formSlug}/payments

Path parameters

organizationSlugstring required

The organization slug

formSlugstring required

The form slug

formType'CrowdFunding' | 'Membership' | 'Event' | 'Donation' | 'PaymentForm' | 'Checkout' | 'Shop' required

The form type CrowdFunding, Membership, Event, Donation, PaymentForm, Checkout, Shop

Query parameters

fromstring date-time

First Date Filter

tostring date-time

End Date Filter (exclusive)

userSearchKeystring

Filter results on user or payer first name, last name or email

pageIndexinteger

The page of results to retrieve

pageSizeinteger

The number of items per page

continuationTokenstring

Continuation Token from which we wish to retrieve results

statesHelloAssoApiV5CommonModelsEnumsPaymentState[]

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'Asc' | 'Desc'

Sort payments by ascending or descending order. Default is descending

sortField'Date' | 'UpdateDate' | 'CreationDate'

Sort payments by a specific field (Date or UpdateDate). Default is date

Response

Success