Usa esto cuando incorpores una nueva ubicación de comercio a Hyfin, o cuando cambien sus datos.
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.
Cada sitio, grupo de sitios y empresa de sitios pertenece a una agencia, el nivel superior a ellos. Indique la agencia en el sitio, grupo de sitios o empresa de sitios, y se creará la primera vez que la use. Después de eso, el mismo externalId siempre apunta a la misma agencia, y los campos de la agencia que envíe no se modifican. Las agencias pertenecen a una sola app, por lo que el mismo externalId en otra app es una agencia diferente.
Para recibir pagos con tarjeta o ACH, un sitio necesita una pasarela de pago para ese tipo de pago. Envíe un objeto gateway, con la pasarela code y su credentials, dentro del tipo de pago. Cada pasarela necesita sus propias claves de credenciales. Pregunte a soporte qué claves necesita la suya.
{
"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"
}