Sign in

v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB
Paiements

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

post/payments/{paymentId}/refund

Path parameters

paymentIdinteger required

The payment identifier.

Query parameters

commentstring

The comment about this refund.

cancelOrderboolean

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

sendRefundMailboolean

Whether a refund mail must be sent or not.

amountinteger

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

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

x-mfa-sms-access-authorizationstring

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

x-mfa-password-authorizationstring

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

Response

Success

idinteger

The refund operation id

amountinteger

The amount to refund

cancelOrderboolean

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

creationDatestring date-time

The refund operation creation date

state'Unknown' | 'Init' | 'Processing' | 'Processed' | 'Error' | 'InternalError' | 'Refused' | 'Aborted' | 'Canceled'
sendRefundMailboolean

Whether a refund mail must be send or not.

paymentIdinteger

The payment id