Add/Update Payment

Utilisez ceci pour enregistrer un paiement reçu en dehors de Hyfin, comme un chèque ou de l'argent comptant, afin que Facture l'affiche.


The following endpoint can be used to add or update a payment within the Hyfin application that were already processed.


Point de terminaison

The following endpoint can be used to add or update a payment. You must replace the {base_url} and {site_id} variable with the site id that was provided when the site was created.

POST
{base_url}/api/v4/site/{site_id}/payment/addUpdate

Demande
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
gatewayTransactionId
String
L'identifiant unique qui a été attribué à l'enregistrement de paiement par la passerelle lorsque le paiement a été traité.
invoice
Une référence à l'enregistrement Facture. En écriture, c'est ainsi que le paiement est appliqué à Facture; elle est retournée en lecture, avec la liste plus complète allocations.
allowMissingInvoice
Boolean
Lorsque invoice.externalId désigne une Facture qui n'a pas encore été envoyée, enregistrez le paiement sans l'appliquer au lieu de le rejeter. Un appel Add/Update Invoice avec ce externalId dans un délai de 30 jours y applique le paiement. Sans cette option, le paiement est rejeté avec Invoice was not found et rien n'est enregistré.
Default = false
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
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.
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.
deleted
Boolean
Ce drapeau représente si l'enregistrement est supprimé et n'est plus disponible pour être utilisé.
Sample Request
			
{
  "externalId": "65432325",
  "gatewayTransactionId": "53912387124235234",
  "type": "payment_card",
  "subType": "visa",
  "displayName": "VISA **** 5123",
  "amount": 3515,
  "paidOn": "2021-01-01T14:32:18.000Z",
  "status": "captured",
  "allocations": [
    {
      "refType": "Invoice",
      "ref": "61f32dc2f62bdc6a48951255",
      "amount": 3515
    }
  ]
}


		
Réponse
Champ
Type
Description
success
Boolean
Whether the record was added or updated successfully.
action
String
Informs whether the record was added or updated. Will only be returned if success is true.
One of added, updated
_id
String
The id we assign to the record.
updatedAt
The date the record was last updated. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
errors
String [ ]
A list of errors. Will only be returned if success is false.
			
{
  "success": true,
  "action": "added",
  "_id": "60f720d248f143332af022e0",
  "updatedAt": "2025-05-30T19:19:44.143Z"
}


		

Voir aussi