Feed-API
Anleitung zur technischen Integration in die LOVAT-Systeme
Begriffe und Abkürzung
API – Programmierschnittstelle. Eine Reihe von Aufrufen, die vom System bereitgestellt werden, erfordern die Integration in externe Softwareprodukte.
Merchant – der Besitzer eines Online-Shops.
Customer – eine Person, die für Waren oder Dienstleistungen bezahlt.
Transaction – Überweisung von Geldern für Waren oder Dienstleistungen, die der Kunde vom Händler erhalten hat.
Token – Eine geheime Zeichenfolge, die vom System verwendet wird, um den Händler und die Website zu identifizieren, über die die Transaktion registriert wird.
API-Beschreibung
Sendemethode.
Beschreibung der Methode.
Die SEND-Methode implementiert den Empfang von Daten zur Transaktion unter Berücksichtigung der Verarbeitung und Berechnung der Mehrwertsteuer und der Systemgebühren.
Referrer-URL
Die Methode ist unter der folgenden UR verfügbar:
https://merchant.vatcompliance.co/api/1/
send/{access_token}?if_digital={true/false}&if_vat_calculate={true/false}
Anrufoptionen
Anrufparameter werden in zwei Typen unterteilt:
- Pfadparameter (Token)
- Abfrageparameter (Transaktionsdaten)
Das Token wird in der ersten Phase des Hinzufügens der Website im internen Konto des Händlers generiert. Sie können es von Ihrem Manager erhalten oder im Abschnitt Store – Einstellungen finden.
Die Anforderungsparameter werden vom Händler generiert und mithilfe der POST-Methode
in der Anwendung an den Server gesendet
/ x-www-form-urlencoded or application / json format
Digitale Dienste
Parameter | Typ / Beispiel | Beispiel Beschreibung | Validierung |
transaction_id | String/ 555-yyy | Transaktions-ID | Maximal 255 Zeichen. Kein leerer Wert. |
transaction_datetime | DateTime / 2017-01-09T08:27:22 +00:00 | Datum und Uhrzeit der Transaktion gemäß ISO 8601 GMT | Kein leerer Wert. |
transaction_sum | String / 25 | Transaktionshöhe | Maximal 45 Zeichen. Kein leerer Wert. |
customer_ip | String / 127.0.0.1 | IP-Adresse des Kunden | Maximal 45 Zeichen. |
currency | String / “usd”, “eur”, “rub”, “gbp” | Transaktionswährung | Maximal 3 Zeichen. Kein leerer Wert. |
customer_phone_number | String / “+7 AAA BBB BB BB” | Telefonnummer des Kunden | Maximal 100 Zeichen. |
arrival_country | String / “GBR” | Alle Länder sind als Zeichenfolgen gemäß ISO 3166-1 Alpha-3 angegeben | Maximal 3 Zeichen. |
arrival_city | String / “London” | Ankunftsort | Maximal 255 Zeichen. |
arrival_address_line | String / “Peckham Road” | Ankunftsadresszeile | Maximal 255 Zeichen. |
transaction_status | String / “Success”, “Charge back”, “refund”,
“Movement own goods” |
Transaktionsstatus | Kein leerer Wert. |
service_code | String / “1” | Code des Händlerservicetyps Wenn der Händler keine Daten zum Typ des erbrachten Dienstes sendet, wird der Transaktion der nominelle Haupttyp des Händlerservices zugewiesen, der bei der Registrierung angegeben wurde
|
Maximal 255 Zeichen. Kein leerer Wert. |
bank_card_number | String / “1234-****-****-****” | Bankkartennummer des Käufers | Maximal 19 Zeichen. |
payment_operator | String / “payonline” paypal” | Zahlungsbetreiber | Maximal 45 Zeichen. Kein leerer Wert. |
payment_method_country | String / “USA” | Zahlungsmöglichkeit nach Land. Alle Länder sind als Zeichenfolgen gemäß ISO 3166-1 Alpha-3 angegeben | Maximal 3 Zeichen. Kein leerer Wert. |
billing_country | String / “USA” | Rechnungsland (Adresse des Zahlungseigners). Alle Länder sind als Zeichenfolgen gemäß ISO 3166-1 Alpha-3 angegeben | Maximal 3 Zeichen. Kein leerer Wert. |
billing_address | String / “111 First Street,Saratoga, CA 95070, US” | Rechnungsadresse (Adresse des Zahlungseigners) | Maximal 255 Zeichen. Kein leerer Wert. |
Server-Antwortcode
Die Antwort auf die Abfrage verwendet den grundlegenden HTTP-Code
Code | Explanation | Response Content |
200 OK | Anfrage bearbeitet | |
400 BadRequest | Ungültige Anfrage | { error : “Problem with data” } |
401 Unauthorized | Unautorisierter Zugriff | { error : “Token is invalid.” } |
Beispielabfrage für digitale Dienste:
Beispielanforderung von der Konsole
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 ** * **", }'
Waren
Parameter | Typ / Beispiel | Beispiel Beschreibung | Validierung |
transaction_id | String/ 555-yyy | Transaktions-ID | Maximal 255 Zeichen. Kein leerer Wert. |
transaction_datetime | DateTime / 2017-01-09T08:27:22 +00:00 | Datum und Uhrzeit der Transaktion gemäß ISO 8601 GMT | Kein leerer Wert. |
transaction_sum | String / 25 | Transaktionshöhe | Maximum 45 characters. Kein leerer Wert. |
currency | String / “GBP”,
“EUR”, “RUB” |
Alle Währungen sind gemäß ISO 4217 als Zeichenfolgen angegeben | Maximal 3 Zeichen. Kein leerer Wert. |
arrival_country | String / “GBR” | Alle Länder sind als Zeichenfolgen gemäß ISO 3166-1 Alpha-3 angegeben | Maximal 3 Zeichen. |
arrival_city | String / “London” | Ankunftsort | Maximal 255 Zeichen. |
arrival_address_line | String / “Peckham Road” | Ankunftsadresszeile | Maximal 255 Zeichen. |
transaction_status | String / “Success”, “Charge back”, “refund”,
“Movement own goods” |
Transaktionsstatus | Kein leerer Wert. |
good_code | String / “62160000” | Code eines Gutes gemäß dem achtstelligen Kodierungssystem der EU Die kombinierte Nomenklatur (CN) | Maximal 8 Zeichen. |
vat_percent | Float / 20.00 | Mehrwertsteuer Prozent | Maximal 8 Zeichen. |
vat | Float / 28.73 | Mehrwertsteuerbetrag | Schweben |
departure_country | String / “AUS” | Zahlungsmöglichkeit nach Land. Alle Länder sind als Zeichenfolgen gemäß ISO 3166-1 Alpha-3 angegeben | Maximal 3 Zeichen. Kein leerer Wert. |
taxable_jurisdiction | String / “GBR” | Zahlungsmöglichkeit nach Land. Alle Länder sind als Zeichenfolgen gemäß ISO 3166-1 Alpha-3 angegeben | Maximal 3 Zeichen. |
buyer_vat_number | String / “UK123123123” | Käufer-Umsatzsteuer-Identifikationsnummer EU | Maximal 255 Zeichen. |
Beispielabfrage für Waren:
Beispielanforderung von der Konsole
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", }'
Service-Code-Liste
Audio- / Videoinhalt | 1 |
Live-Streaming | 2 |
Telefondienste | 3 |
Internet-Telefondienste | 4 |
Anrufverwaltungsdienste | 5 |
Paging-Dienste | 6 |
Internet Zugang | 7 |
Bilder | 8 |
Musik- | 9 |
Spiele | 10 |
eNewspapers | 11 |
Web-Hosting | 12 |
Distanzpflege von Programmen | 13 |
Werbeflächen auf einer Website | 14 |
E-Books | 15 |
Lizenzen | 16 |
Dating | 17 |
Fernstudium | 18 |
Glücksspiel | 19 |
Lieferung von Waren | 20 |
andere digitale | 21 |