Get Payment

Utilisez ceci lorsque vous avez besoin de tous les détails d'un paiement, par exemple après un webhook de paiement.


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 que nous attribuons à ce paiement. Omettez-le lors de la création d'un paiement et envoyez-le lors de la mise à jour d'un paiement.
externalId
String
Votre propre identifiant pour ce paiement, provenant de votre logiciel. Obligatoire lorsque _id n'est pas transmis. Envoyez à nouveau le même externalId pour mettre à jour ce paiement au lieu d'en ajouter un nouveau. Nous faisons la correspondance sur cette valeur, mais nous n'empêchons pas les doublons; gardez-la donc unique au sein du site.
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
La date et l'heure à laquelle le paiement a été effectué. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
status
String
Le statut actuel du paiement. created : enregistré, mais pas encore envoyé au processeur. failed : la tentative a échoué avant que le processeur ne réponde. declined : le processeur l'a refusé. expired : il n'a pas été complété à temps. cancelled : il a été annulé avant d'être traité. authorized : la carte a été approuvée et les fonds sont retenus, mais pas encore débités. captured : le paiement a été débité et n'est pas encore réglé. settled : le processeur a réglé les fonds. voided : annulé avant le règlement, donc aucun argent n'a été transféré. refundRequested : un remboursement attend le règlement du paiement. returned : la banque a renvoyé le paiement. chargebacked : le titulaire de la carte a contesté le paiement. Un remboursement est un paiement distinct, avec refunded, refundSettled ou refundFailed.
Default = captured | One of failed, declined, created, expired, cancelled, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled, chargebacked, refundRequested
manualStatusChange
Le dernier changement de statut effectué manuellement par un utilisateur dans l'application, par exemple marquer un paiement comme refusé. Utilisez-le pour distinguer un changement manuel d'un changement signalé par la passerelle de paiement. Omis lorsque personne n'a modifié manuellement le statut du paiement.
customer
String
L'_id du client qui a effectué le paiement.
site
String
L'identifiant du site
type
String
Le type de mode de paiement utilisé pour effectuer le paiement. credit est un crédit appliqué à une facture (voir credit); il est défini par le système et ne peut pas être envoyé.
One of payment_card, ach, eft, apple_pay, google_pay, oxxo, spei, bnpl, dlocal, cash, check, other, credit
subType
String
Le sous-type de la méthode de paiement utilisée pour effectuer le paiement.
One of visa, mastercard, amex, discover, diners, jcb, checking, savings, oxxo, spei, bnpl, google_pay, dlocal, cash, check, other, creditNote
totals
La ventilation du montant du paiement.
isRefund
Boolean
Indique si le paiement est un remboursement d'un autre paiement.
origPayment
String
Pour un remboursement, l'_id du paiement qu'il a remboursé. Omis pour les paiements qui ne sont pas des remboursements.
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.
credit
String
Pour une application de crédit (type credit), l'_id du crédit qui a été appliqué; null pour tous les autres paiements. Une application de crédit ne déplace aucun argent par une passerelle de paiement, n'entraîne aucuns frais et ne peut pas être remboursée ni mise à jour par l'API.
checkout
Le paiement du portail client dont ce paiement faisait partie, afin de regrouper un paiement par carte et les crédits appliqués avec celui-ci; null autrement.
syncToPrimaryOnly
Boolean
true pour une application de crédit : elle indique comment une facture a été réglée et ne doit pas être comptabilisée dans un système comptable comme un paiement en espèces.
authCode
String
Le code d'autorisation retourné par la passerelle de paiement lorsqu'elle a approuvé le paiement; null lorsqu'elle n'en a retourné aucun, comme pour la plupart des paiements bancaires.
paymentGatewayTransaction
L'enregistrement du paiement par la passerelle de paiement.
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.
			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "externalId": "62331255",
  "displayName": "VISA **** 5123",
  "site": "6201825a0cf5e23261a08646",
  "customer": "649dc5bb468bd5b5d863c7d1",
  "type": "payment_card",
  "subType": "visa",
  "amount": 3515,
  "totals": {
    "taxes": 0,
    "discounts": 0,
    "total": 3515
  },
  "paidOn": "2021-01-01T14:32:18.000Z",
  "status": "captured",
  "isRefund": false,
  "allocations": [
    {
      "refType": "Invoice",
      "ref": "61f32dc2f62bdc6a48951255",
      "amount": 3515
    }
  ],
  "authCode": "253558",
  "paymentGatewayTransaction": {
    "id": "53912387124235234",
    "key": "253558",
    "keyDisplay": "Auth Code"
  },
  "paymentTransactionEvents": [
    {
      "type": "sale",
      "amount": 3515,
      "successful": true,
      "createdAt": "2021-01-01T14:32:18.000Z",
      "transactionId": "53912387124235234"
    }
  ]
}


		

Voir aussi