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/v3.1/site/{site_id}/payment/addUpdate

Demande
Champ
Type
Description
external_id
String
Votre propre identifiant pour ce paiement, provenant de votre logiciel. Envoyez de nouveau le même external_id 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.
display_name
String
Le nom convivial sécurisé de la méthode de paiement. Exemple : VISA **** 3421.
amount
Number
Le montant qui a été payé. Format = 0.00
paid_on
Timestamp
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:ssZ
gateway_transaction_id
String
L'identifiant unique qui a été attribué à l'enregistrement de paiement par la passerelle lorsque le paiement a été traité.
tip
Number
Le montant du pourboire qui a été ajouté. Format = 0.00
tax
Number
Le montant de taxe qui a été ajouté. Format = 0.00
fee
Number
Le montant des frais qui a été ajouté. Format = 0.00
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.
allow_missing_invoice
Boolean
Lorsque invoice.external_id 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 external_id 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
payment_type
String
Le type de méthode de paiement utilisé pour effectuer le paiement.
One of payment_card, ach, eft, apple_pay, google_pay, oxxo, spei, bnpl, dlocal, cash, check, other
payment_sub_type
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
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
transaction_type
String
Le type de transaction. Consigné sur le paiement, mais non retourné par les points de terminaison de lecture.
One of sale, capture, refund, void
active
Boolean
Ce drapeau représente si l'enregistrement de paiement est actif.
Default = true
Sample Request
			
{
  "external_id": "65432325",
  "gateway_transaction_id": "53912387124235234",
  "payment_type": "payment_card",
  "payment_sub_type": "visa",
  "display_name": "VISA **** 5123",
  "amount": 35.15,
  "paid_on": "2021-01-01T14:32:18Z",
  "status": "captured",
  "invoice": {
    "external_id": "65432661"
  }
}


		
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.
id
String
The same id as _id, kept for backwards compatibility. Not returned on 4.0 and later.
errors
String [ ]
A list of errors. Will only be returned if success is false.
			
{
  "success": true,
  "action": "added",
  "_id": "60f720d248f143332af022e0",
  "id": "60f720d248f143332af022e0"
}


		

Voir aussi