Rembourser un paiement.

post

https://api.helloasso.com/v5/payments/{paymentId}/refund

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

Path Params

paymentId

int32

required

The payment identifier.

Query Params

comment

string

The comment about this refund.

cancelOrder

boolean

Defaults to false

Whether the future payments and linked items of this order must be canceled (possible only if the payment is fully refunded)

sendRefundMail

boolean

Defaults to true

Whether a refund mail must be sent or not.

amount

int32

Defaults to 0

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

Headers

x-mfa-access-authorization

string

Must be filled only if AuthorizationErrors.MFA.AccessTokenRequired error code was returned previously.

x-mfa-sms-access-authorization

string

Must be filled only if AuthorizationErrors.MFA.AccessOtpSmsRequired error code was returned previously.

x-mfa-password-authorization

string

Must be filled only if AuthorizationErrors.MFA.AccessPasswordTokenRequired error code was returned previously.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

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

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

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

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

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

200Success

Multi-Factor Authentication Required