HEhelloasso
Paiements

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

get/payments/{paymentId}

Request

  • Base URL
    https://api.helloasso.com/v5
  • URL
    https://api.helloasso.com/v5/payments/{paymentId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.helloasso.com/oauth2/token

Path parameters

paymentIdinteger required

The payment identifier.

Query parameters

withFailedRefundOperationboolean

True to retrieve the refund operation in the states 'ABORTED', 'CANCELED', 'ERROR', 'REFUSED'.

Response

Success

cardExpirationDatestring date-time nullable

Card expiration date (only for card payments)

cashOutDatestring date-time nullable

The date of the cash out

idCashOutinteger nullable

The id of the cash out

cashOutState'MoneyIn' | 'CantTransferReceiverFull' | 'Transfered' | 'Refunded' | 'Refunding' | 'WaitingForCashOutConfirmation' | 'CashedOut' | 'Unknown' | 'Contested' | 'TransferInProgress'
paymentReceiptUrlstring nullable

The Payment Receipt Url

fiscalReceiptUrlstring nullable

The Fiscal Receipt Url

idinteger

The ID of the payment

amountinteger

Total Amount of the payment (in cents)

amountTipinteger nullable

Tip Amount of the payment (in cents)

datestring date-time

Date of the payment

paymentMeans'None' | 'Card' | 'Sepa' | 'Check' | 'Cash' | 'BankTransfer' | 'Other'
installmentNumberinteger nullable

Indicates the payment number (useful in the case of an order comprising payments with installments)

state'Pending' | 'Authorized' | 'Refused' | 'Unknown' | 'Registered' | 'Error' | 'Refunded' | 'Refunding' | 'Waiting' | 'Canceled' | 'Contested' | 'WaitingBankValidation' | 'WaitingBankWithdraw' | 'Abandoned' | 'WaitingAuthentication' | 'AuthorizedPreprod' | 'Corrected' | 'Deleted' | 'Inconsistent' | 'NoDonation' | 'Init'
type'Offline' | 'Credit' | 'Debit'
paymentOffLineMean'None' | 'Card' | 'Sepa' | 'Check' | 'Cash' | 'BankTransfer' | 'Other'

Changes

No recorded changes to this operation across all 1 revision of this API.