A
API de flux
Instructions pour l’intégration technique avec les systèmes LOVAT
Termes et abréviation
API – Interface de programmation d’applications. Un ensemble d’appels fournis par le système demande une intégration avec des produits logiciels externes.
Marchand – le propriétaire d’une boutique en ligne.
Client – une personne qui paie des biens ou des services.
Transaction – transfert de fonds pour des biens ou des services reçus par le client du commerçant.
Jeton – une chaîne secrète utilisée par le système pour identifier le commerçant et le site Web par l’intermédiaire duquel la transaction est enregistrée.
Description de l’API
Méthode d’envoi.
Description de la méthode.
La méthode SEND met en œuvre la réception des données sur la transaction, en tenant compte du traitement et du calcul de la TVA et des charges du système.
URL de référence
La méthode est disponible à l’URL suivante:
https://merchant.vatcompliance.co/api/1/
send/{access_token}?if_digital={true/false}&if_vat_calculate={true/false}
Options d’appel
Les paramètres d’appel sont divisés en deux types:
- Paramètres de chemin (jeton).
- Paramètres de requête (données de transaction).
Le jeton est généré dans le compte interne du commerçant lors de la première étape d’ajout du site Web. Vous pouvez l’obtenir auprès de votre responsable ou le trouver dans la section Store – Paramètres.
Les paramètres de la requête sont générés par le marchand et envoyés au serveur en utilisant la méthode POST dans l'application
/ x-www-form-urlencoded or application / json format
Services numériques
Paramètre |
Genre/Exemple |
Exemple Description |
Validation |
| transaction_id | Chaîne / 555-yyy | Identifiant de transaction | Maximum 255 caractères. Pas une valeur vide. |
| transaction_datetime | DateHeure / 2017-01-09T08:27:22 +00:00 | Date et heure de la transaction conformément à la norme ISO 8601 GMT | Pas une valeur vide. |
| transaction_sum | Chaîne / 25 | Montant de la transaction | 45 caractères maximum. Pas une valeur vide. |
| customer_ip | Chaîne / 127.0.0.1 | Adresse IP du client | 45 caractères maximum. |
| currency | Chaîne / “usd”, “eur”, “rub”, “gbp” | Devise de la transaction | Maximum 3 caractères. Pas une valeur vide. |
| customer_phone_number | Chaîne / “+7 AAA BBB BB BB” | Numéro de téléphone du client | 100 caractères maximum. |
| arrival_country | Chaîne / “GBR” | Tous les pays sont spécifiés sous forme de chaînes conformément à la norme ISO 3166-1 alpha-3 | Maximum 3 caractères. |
| arrival_city | Chaîne / “London” | Ville d’arrivée | Maximum 255 caractères. |
| arrival_address_line | Chaîne / “Peckham Road” | Ligne d’adresse d’arrivée | Maximum 255 caractères. |
| transaction_status | Chaîne / “Success”, “Charge back”, “refund”,
“Movement own goods” |
État de la transaction | Pas une valeur vide. |
| service_code | Chaîne / “1” | Code de type de service marchand Si le marchand n’envoie pas de données sur le type de service fourni, la transaction se voit attribuer le type de service principal nominal du marchand qui a été spécifié lors de l’inscription
|
Maximum 255 caractères. Pas une valeur vide. |
| bank_card_number | Chaîne / “1234-****-****-****” | Numéro de carte bancaire de l’acheteur | 19 caractères maximum. |
| payment_operator | Chaîne / “payonline” paypal” | Opérateur de paiement | 45 caractères maximum. Pas une valeur vide. |
| payment_method_country | Chaîne / “USA” | Option de paiement par pays. Tous les pays sont spécifiés sous forme de chaînes conformément à la norme ISO 3166-1 alpha-3 | Maximum 3 caractères. Pas une valeur vide. |
| billing_country | Chaîne / “USA” | Pays de facturation (adresse du propriétaire du paiement). Tous les pays sont spécifiés sous forme de chaînes conformément à la norme ISO 3166-1 alpha-3 | Maximum 3 caractères. Pas une valeur vide. |
| billing_address | Chaîne / “111 First Street,Saratoga, CA 95070, US” | Adresse de facturation (adresse du propriétaire du paiement) | Maximum 255 caractères. Pas une valeur vide. |
Code de réponse du serveur
La réponse à la requête utilise le code HTTP de base
Code |
Explication |
Contenu de la réponse |
| 200 OK | Demande traitée | |
| 400 BadRequest | Requête invalide | { error : “Problem with data” } |
| 401 Unauthorized | L’accès non autorisé | { error : “Token is invalid.” } |
Exemple de requête pour les services numériques:
Exemple de requête depuis la console
curl -v POST 'http://https://merchant.vatcompliance.co/api/1/ send/5aae918d97964ff88df64b059c2cc0f8?if_digital=false&if_vat_calculate=true' --header "Content-Type: application/json" -d '{ "transaction_id": " ttt4565-85546", "transaction_datetime": "2017-01-09T08:27:22 +00:00", "transaction_sum": 25.99, "customer_ip": "127.0.0.1", "customer_phone_number": "+7 677 ** * **", }'
Marchandises
Paramètre |
Genre/Exemple |
Exemple Description |
Validation |
| transaction_id | Chaîne / 555-yyy | Identifiant de transaction | Maximum 255 caractères. Pas une valeur vide. |
| transaction_datetime | DateHeure / 2017-01-09T08:27:22 +00:00 | Date et heure de la transaction conformément à la norme ISO 8601 GMT | Pas une valeur vide. |
| transaction_sum | Chaîne / 25 | Montant de la transaction | 45 caractères maximum. Pas une valeur vide. |
| currency | Chaîne / “GBP”,
“EUR”, “RUB” |
Toutes les devises sont spécifiées sous forme de chaînes conformément à la norme ISO 4217 | Maximum 3 caractères. Pas une valeur vide. |
| arrival_country | Chaîne / “GBR” | Tous les pays sont spécifiés sous forme de chaînes conformément à la norme ISO 3166-1 alpha-3 | Maximum 3 caractères. |
| arrival_city | Chaîne / “London” | Ville d’arrivée | Maximum 255 caractères. |
| arrival_address_line | Chaîne / “Peckham Road” | Ligne d’adresse d’arrivée | Maximum 255 caractères. |
| transaction_status | Chaîne / “Success”, “Charge back”, “refund”,
“Movement own goods” |
État de la transaction | Pas une valeur vide. |
| good_code | Chaîne / “62160000” | Code d’une marchandise selon le système de codage à huit chiffres de l’UE La nomenclature combinée (NC) | Maximum 8 caractères. |
| vat_percent | Flotter / 20.00 | Pourcentage de TVA | Maximum 8 caractères. |
| vat | Flotter / 28.73 | Montant de la TVA | Flotter |
| departure_country | Chaîne / “AUS” | Option de paiement par pays. Tous les pays sont spécifiés sous forme de chaînes conformément à la norme ISO 3166-1 alpha-3 | Maximum 3 caractères. Pas une valeur vide. |
| taxable_jurisdiction | Chaîne / “GBR” | Option de paiement par pays. Tous les pays sont spécifiés sous forme de chaînes conformément à la norme ISO 3166-1 alpha-3 | Maximum 3 caractères. |
| buyer_vat_number | Chaîne / “UK123123123” | Buyer vat number EU | Maximum 255 caractères. |
Exemple de requête pour les marchandises:
Exemple de requête depuis la console
curl-v POST https://merchant.vatcompliance.co/api/1/send/5aae918d97964ff88df64b059c2cc0f8?if_digital=false&if_vat_calculate=false --header "Content-Type: application/json" -d '{ "transaction_id ": " ttt4565-85546", "transaction_datetime": "2017-01-09T08:27:22 +00:00", "transaction_sum ": 158.04, "currency": "GBP", "arrival_country" : " GBR", "arrival_city" : " London", "arrival_address_line" : " Peckham Road", "transaction_status" : "Success", "good_code": "62160000", "vat_percent": 20.00, "vat": 28.73, "departure_country" : "AUS", }'
Liste des codes de service
| contenu audio/visuel | 1 |
| diffusion en direct | 2 |
| services téléphoniques | 3 |
| services de téléphonie internet | 4 |
| services de gestion des appels | 5 |
| services de radiomessagerie | 6 |
| accès Internet | 7 |
| images | 8 |
| musique | 9 |
| jeux | 10 |
| journaux électroniques | 11 |
| hébergement Web | 12 |
| maintenance à distance des programmes | 13 |
| espace publicitaire sur un site internet | 14 |
| livres électroniques | 15 |
| licences | 16 |
| datation | 17 |
| l’enseignement à distance | 18 |
| jeu d’argent | 19 |
| fourniture de biens | 20 |
| autre numérique | 21 |