API de Feeds
Instrucciones para la integración técnica con los sistemas LOVAT
Términos y Abreviaturas
API – Interfaz de Programación de Aplicaciones. Un conjunto de llamadas proporcionadas por el sistema requiere la integración con productos de software externos.
Merchant – el propietario de una tienda en línea.
Customer – una persona que paga por mercancías o servicios.
Transaction – transferencia de fondos por mercancías o servicios recibidos por el cliente del comerciante.
Token – un string secreta utilizada por el sistema para identificar al comerciante y el sitio web a través del cual se registra la transacción.
Descripción API
Método de envío.
Descripción del método.
El método ENVIAR implementa la recepción de datos sobre la transacción, teniendo en cuenta el procesamiento y cálculo del IVA y los cargos del sistema.
URL de Referencia
El método está disponible en la siguiente URL:
https://merchant.vatcompliance.co/api/1/
send/{access_token}?if_digital={true/false}&if_vat_calculate={true/false}
Opciones de Llamada
Los parámetros de llamada se dividen en dos tipos:
- Parámetros de ruta (token)
- Parámetros de consulta (datos de transacción)
El token se genera en la cuenta interna del comerciante en la primera etapa de agregar el sitio web. Puede obtenerlo de su gerente o encontrarlo en la Sección Tienda – Configuración.
Los parámetros de la solicitud son generados por el comerciante y enviados al servidor mediante el método POST en la aplicación
/ x-www-form-urlencoded or application / json format
Servicios Digitales
Parámetro | Tipo/Ejemplo | Descripción del Ejemplo | Validación |
transaction_id | String/ 555-yyy | ID de transacción | Máximo 255 caracteres. No es un valor vacío. |
transaction_datetime | DateTime / 2017-01-09T08:27:22 +00:00 | Fecha y hora de la transacción de acuerdo con ISO 8601 GMT | No es un valor vacío. |
transaction_sum | String / 25 | Suma de transacción | Máximo 45 caracteres. No es un valor vacío. |
customer_ip | String / 127.0.0.1 | Dirección IP del cliente | Máximo 45 caracteres. |
currency | String / “usd”, “eur”, “rub”, “gbp” | Moneda de la transacción | Máximo 3 caracteres. No es un valor vacío. |
customer_phone_number | String / “+7 AAA BBB BB BB” | Número de teléfono del cliente | Máximo 100 caracteres. |
arrival_country | String / “GBR” | Todos los países se especifican como string de acuerdo con ISO 3166-1 alpha-3 | Máximo 3 caracteres. |
arrival_city | String / “London” | Ciudad de Llegada | Máximo 255 caracteres. |
arrival_address_line | String / “Peckham Road” | Línea de dirección de llegada | Máximo 255 caracteres. |
transaction_status | String / “Success”, “Charge back”, “refund”, “Movement own goods” | Estado de transacción | No es un valor vacío. |
service_code | String / “1” | Código del tipo de servicio del comerciante. Si el comerciante no envía datos sobre el tipo de servicio prestado, a la transacción se le asigna el tipo principal nominal de servicio del comerciante que se especificó en el registro | Máximo 255 caracteres. No es un valor vacío. |
bank_card_number | String / “1234-****-****-****” | Número de la tarjeta bancaria del comprador | Máximo 19 caracteres. |
payment_operator | String / “payonline” paypal” | Operador de Pago | Máximo 45 caracteres. No es un valor vacío. |
payment_method_country | String / “USA” | Opción de pago por país. Todos los países se especifican como string de acuerdo con ISO 3166-1 alpha-3 | Máximo 3 caracteres. No es un valor vacío. |
billing_country | String / “USA” | País de facturación (dirección del propietario del pago). Todos los países se especifican como string de acuerdo con ISO 3166-1 alpha-3 | Máximo 3 caracteres. No es un valor vacío. |
billing_address | String / “111 First Street,Saratoga, CA 95070, US” | Dirección de facturación (dirección del propietario del pago) | Máximo 255 caracteres. No es un valor vacío. |
Código de Respuesta del Servidor
La respuesta a la consulta utiliza el código HTTP básico
Código | Explicación | Contenido de Respuesta |
200 OK | Solicitud procesada | |
400 BadRequest | Solicitud no válida | { error : “Problem with data” } |
401 Unauthorized | Acceso no autorizado | { error : “Token is invalid.” } |
Ejemplo de solicitud para servicios digitales:
Ejemplo de comandos de la consola de comandos
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 ** * **", }'
Mercancías
Parámetro | Tipo/Ejemplo | Descripción de Ejemplo | Validación |
transaction_id | String/ 555-yyy | ID de transacción | Máximo 255 caracteres. No es un valor vacío. |
transaction_datetime | DateTime / 2017-01-09T08:27:22 +00:00 | Fecha y hora de la transacción de acuerdo con ISO 8601 GMT | No es un valor vacío. |
transaction_sum | String / 25 | Suma de transacción | Máximo 45 caracteres. No es un valor vacío. |
currency | String / “GBP”, “EUR”, “RUB” | Todas las monedas se especifican como string de acuerdo con ISO 4217 | Máximo 3 caracteres. No es un valor vacío. |
arrival_country | String / “GBR” | Todos los países se especifican como string de acuerdo con ISO 3166-1 alpha-3 | Máximo 3 caracteres. |
arrival_city | String / “London” | Ciudad de llegada | Máximo 255 caracteres. |
arrival_address_line | String / “Peckham Road” | Línea de dirección de llegada | Máximo 255 caracteres. |
transaction_status | String / “Success”, “Charge back”, “refund”, “Movement own goods” | Estado de transacción | No es un valor vacío. |
good_code | String / “62160000” | Código de mercancía según el sistema de codificación de ocho dígitos de la UE – la Nomenclatura Combinada | Máximo 8 caracteres. |
vat_percent | Float / 20.00 | Porcentaje de IVA | Máximo 8 caracteres. |
vat | Float / 28.73 | Importe del IVA | Flotador |
departure_country | String / “AUS” | Opción de pago por país. Todos los países se especifican como string de acuerdo con ISO 3166-1 alpha-3 | Máximo 3 caracteres. No es un valor vacío. |
taxable_jurisdiction | String / “GBR” | Opción de pago por país. Todos los países se especifican como string de acuerdo con ISO 3166-1 alpha-3 | Máximo 3 caracteres. |
buyer_vat_number | String / “UK123123123” | Número de IVA del comprador UE | Máximo 255 caracteres. |
Ejemplo de solicitud de mercancía:
Ejemplo de comandos de la consola de comandos
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", }'
Lista de Códigos de Servicio
contenido audio/visual | 1 |
transmisión en vivo | 2 |
servicios telefónicos | 3 |
servicios telefónicos por internet | 4 |
servicios de gestión de llamadas | 5 |
servicios de radiobúsqueda | 6 |
acceso a Internet | 7 |
imágenes | 8 |
música | 9 |
juegos | 10 |
periódicos electrónicos | 11 |
alojamiento web | 12 |
mantenimiento a distancia de programas | 13 |
espacio publicitario en un sitio web | 14 |
libros electrónicos | 15 |
licencias | 16 |
citas | 17 |
educación a distancia | 18 |
juegos de azar | 19 |
suministro de mercancías | 20 |
otro digital | 21 |