Add/Update Payment
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
Le même point de terminaison est utilisé pour ajouter ou mettre à jour a Paiement. Si le {_id} est fourni, le Paiement sera mis à jour sinon il sera inséré.
Demande
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.
externalId
String
L'identifiant unique du paiement provenant du système/de la base de données source. Obligatoire lorsque _id n'est pas transmis. Si nous détectons un enregistrement avec le même externalId, il sera mis à jour; sinon, il sera ajouté.
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
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.
status
String
L'état actuel du paiement.
Default = captured | One of declined, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled
Default = captured | One of declined, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled
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
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
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.
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:18Z",
"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
One of added, updated
_id
String
The auto generated id assigned to the record.
updatedAt
Date
The date the record was last updated.
errors
String [ ]
A list of errors. Will only be returned if success is false.
Sample Response (Successful)
{
"success": true,
"action": "added",
"_id": "60f720d248f143332af022e0",
"updatedAt": "2025-05-30T19:19:44.143Z"
}
Sample Response (Failed)
{
"success": false,
"errors": [
"invalid field2",
"missing field_name"
]
}