Ajouter/Mettre à jour le site
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).
Point de terminaison
The following endpoint can be used to add or update sites. You must replace the {base_url} variable.
POST
{base_url}/api/v4/site/addUpdate
Le même point de terminaison est utilisé pour ajouter ou mettre à jour a site. Si le {_id} est fourni, le site sera mis à jour sinon il sera inséré.
Demande
Champ
Type
Description
externalId
String
The unique id assigned by the source system/database. If we detect a record with the same `external_id`, it will be updated, otherwise it will be added.
name
String
Le nom du site/entreprise.
merchantId
String
L'identifiant du commerçant attribué à l'entreprise par la banque acquéreuse/le processeur.
agency
Agency
Une référence au dossier de l'agence.
location
L'adresse commerciale de ce site/entreprise.
primaryContact
The main person responsible for the business. Not required if `access_type = api_only`.
siteEnterprise
Une référence au dossier de l'entreprise du site.
siteGroup
Une référence à l'enregistrement du groupe de sites.
branding
La marque unique de l'entreprise, y compris le logo et la couleur principale.
accessType
String
The level of access the site is requesting. Use `api_only` if you do not wish to send the welcome email to the primary contact.
Default = `basic` | One of `api_only`, `basic`, `pro`
Default = `basic` | One of `api_only`, `basic`, `pro`
webhook
Configurer des webhooks pour recevoir des mises à jour en temps réel lorsque des données liées à ce site sont mises à jour.
paymentTypes
Les modes de paiement disponibles pour accepter les paiements des clients. Au moins un mode de paiement est requis.
deleted
Boolean
Ce drapeau représente si l'enregistrement est supprimé et n'est plus disponible pour être utilisé.
Sample Request
{
"external_id": "12345678",
"name": "Sample Company",
"merchant_id": "123544633452",
"agency": {
"external_id": "65123125",
"name": "Sample Agency"
},
"location": {
"address_line1": "123 Main Street",
"address_line2": "Suite 123",
"city": "Naples",
"state_code": "FL",
"zip_code": "34102",
"phone": "239-123-1234",
"website": "https://samplecompany.com"
},
"primary_contact": {
"first_name": "Thomas",
"last_name": "Smith",
"email": "tsmith@samplecompany.com",
"mobile_phone": "239-987-6543"
},
"payment_types": {
"payment_card": {
"active": true,
"gateway": {
"code": "gatewaycode",
"credentials": {
"key": "value",
"key_2": "value2"
}
}
},
"ach": {
"active": true,
"gateway": {
"code": "gatewaycode",
"credentials": {
"key": "value",
"key_2": "value2"
}
}
}
},
"branding": {
"logo_url": "https://samplecompany.com/images/logo.png",
"logo_base64": "",
"color": "#336699"
},
"access_type": "basic",
"active": true,
"webhook": {
"active": true,
"url": "https://mysoftware.com/webhook"
}
}
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.
errors
String [ ]
A list of errors. Will only be returned if `success` is `false`.
Sample Response (Successful)
{
"success": true,
"action": "added",
"_id": "60f720d248f143332af022e0"
}
Sample Response (Failed)
{
"success": false,
"errors": [
"invalid field2",
"missing field_name"
]
}