Utilisez ceci lorsque vous ajoutez un nouvel emplacement de commerçant sur Hyfin, ou lorsque ses détails changent.
A site must be created prior to making any of the standard API calls. A unique site should be created for each unique Merchant ID (MID).
The following endpoint can be used to add or update sites. You must replace the {base_url} variable.
Chaque site, groupe de sites et entreprise de sites appartient à une agence, le niveau supérieur. Indiquez le nom de l'agence sur le site, le groupe de sites ou l'entreprise de sites, et elle est créée la première fois que vous l'utilisez. Par la suite, le même externalId renvoie toujours à la même agence, et les champs d'agence que vous envoyez ne sont pas modifiés. Les agences appartiennent à une seule application; le même externalId dans une autre application correspond donc à une agence différente.
Pour accepter les paiements par carte ou par ACH, un site a besoin d'une passerelle de paiement pour ce type de paiement. Envoyez un objet gateway, avec la passerelle code et ses credentials, sous le type de paiement. Chaque passerelle nécessite ses propres clés d'identification. Demandez au soutien quelles clés la vôtre exige.
{
"externalId": "12345678",
"name": "Sample Company",
"merchantId": "123544633452",
"agency": {
"externalId": "65123125",
"name": "Sample Agency"
},
"location": {
"addressLine1": "123 Main Street",
"addressLine2": "Suite 123",
"city": "Naples",
"stateCode": "FL",
"zipCode": "34102",
"phone": "239-123-1234",
"website": "https://samplecompany.com"
},
"primaryContact": {
"firstName": "Thomas",
"lastName": "Smith",
"email": "tsmith@samplecompany.com",
"mobilePhone": "239-987-6543"
},
"paymentTypes": {
"paymentCard": {
"active": true,
"gateway": {
"code": "gatewaycode",
"credentials": {
"key": "value",
"key2": "value2"
}
}
},
"ach": {
"active": true,
"gateway": {
"code": "gatewaycode",
"credentials": {
"key": "value",
"key2": "value2"
}
}
}
},
"branding": {
"logoUrl": "https://samplecompany.com/images/logo.png",
"color": "#336699"
},
"accessType": "basic",
"webhook": {
"active": true,
"url": "https://mysoftware.com/webhook"
},
"deleted": false
}
{
"success": true,
"action": "added",
"_id": "60f720d248f143332af022e0",
"updatedAt": "2025-05-30T19:19:44.143Z"
}