Docs de l'API 3.1Docs de l'API 4.0 SimpleDocs de l'API 4.0

Get Payment

The following endpoint can be used to retrieve the details of a payment within the Hyfin application.

Point de terminaison

The following endpoint can be used to retrieve a payment. You must replace the {base_url} , {_id} and {site_id} variables with the appropriate values.

GET
{base_url}/api/v4/site/{site_id}/payment/{_id}
Demande
Aucun corps n'est requis pour cet appel API
Réponse
Champ
Type
Description
_id
String
L'identifiant du paiement. Ce champ est généré automatiquement par le système et n'est pas requis lors de la création d'un nouveau paiement, mais il est requis lors de la mise à jour d'un paiement existant.
displayName
String
Le nom convivial sécurisé de la méthode de paiement. Exemple : VISA **** 3421.
amount
Number
Le montant qui a été payé. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
paidOn
Date
La date et l'heure à laquelle le paiement a été effectué. Format = YYYY-MM-DDTHH:mm:ssZ
status
String
L'état actuel du paiement.
Default = captured | One of declined, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled
createdAt
Date
La date à laquelle le paiement a été créé.
updatedAt
Date
La date à laquelle le paiement a été dernièrement mis à jour.
site
String
L'identifiant du site
type
String
Le type de méthode de paiement utilisé pour effectuer le paiement.
One of payment_card, ach, cash, check
subType
String
Le sous-type de la méthode de paiement utilisée pour effectuer le paiement.
One of checking, savings, visa, mastercard, discover, amex, cash, other
totals
Les montants totaux du paiement.
allocations
Les allocations pour le paiement. Il s'agit d'un tableau d'objets qui spécifient comment le paiement a été alloué à différentes commandes ou remboursements.
paymentTransactionEvents
Les événements de transaction pour le paiement. Il s'agit d'un tableau d'objets qui spécifient l'historique de la transaction de paiement, comme quand elle a été autorisée, capturée, remboursée, etc.
deleted
Boolean
Ce drapeau représente si l'enregistrement est supprimé et n'est plus disponible pour être utilisé.
Sample Response
			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "paymentType": "payment_card",
  "paymentSubType": "amex",
  "displayName": "AMEX ****** 3422",
  "last4": "3422",
  "amount": 3000,
  "paidOn": "2021-03-15T16:32:11Z",
  "status": "captured",
  "transactionType": "capture",
  "createdAt": "2025-05-30T19:19:44.143Z",
  "updatedAt": "2025-05-30T19:19:44.143Z",
  "deleted": false
}