馈送 API
与LOVAT系统进行技术集成的说明
术语和缩写
API – 应用程序编程接口。系统提供的一组调用,用于与外部软件产品集成。
商户 – 在线商店的所有者。
客户 – 支付商品或服务费用的个人。
交易 – 客户从商户处收到商品或服务时的资金转移。
令牌 – 系统用来识别商户和注册交易的网站的秘密字符串。
API描述
发送方法(Send method)。
方法描述。
发送方法实现了交易数据的接收,包括增值税(VAT)和系统费用的处理和计算。
引用URL
该方法可通过以下URL访问:
https://merchant.vatcompliance.co/api/1/ send/{access_token}?if_digital={true/false}&if_vat_calculate={true/false}
调用选项
调用参数分为两种类型:
- 路径参数(令牌)
- 查询参数(交易数据)
令牌在添加网站的第一阶段由商户的内部账户生成。您可以从您的经理处获得或在“商店 – 设置”部分中找到。
请求参数由商户生成,并使用POST方法发送到服务器, 格式为 / x-www-form-urlencoded 或 application / json
数字服务
参数 | 类型/示例 | 示例说明 | 验证 |
transaction_id | 字符串/ 555-yyy | 交易ID | 最多255个字符。不能为空。 |
transaction_datetime | 日期时间 / 2017-01-09T08:27:22 +00:00 | 根据ISO 8601 GMT格式的交易日期和时间 | 不能为空。 |
transaction_sum | 字符串 / 25 | 交易金额 | 最多45个字符。不能为空。 |
customer_ip | 字符串 / 127.0.0.1 | 客户IP地址 | 最多45个字符。 |
currency | 字符串 / “usd”, “eur”, “rub”, “gbp” | 交易货币 | 最多3个字符。不能为空。 |
customer_phone_number | 字符串 / “+7 AAA BBB BB BB” | 客户电话号码 | 最多100个字符。 |
arrival_country | 字符串 / “GBR” | 根据ISO 3166-1 alpha-3格式的国家代码 | 最多3个字符。 |
arrival_city | 字符串 / “London” | 到达城市 | 最多255个字符。 |
arrival_address_line | 字符串 / “Peckham Road” | 到达地址 | 最多255个字符。 |
transaction_status |
字符串 / “Success”, “Charge back”, “refund”, “Movement own goods” |
交易状态 | 不能为空。 |
service_code | 字符串 / “1” |
商户服务类型代码。如果商户未提供服务类型数据,交易将被分配为注册时指定的商户服务的主要类型。
|
最多255个字符。不能为空。 |
bank_card_number | 字符串 / “1234-****-****-****” | 买家的银行卡号 | 最多19个字符。 |
payment_operator | 字符串 / “payonline” paypal” | 支付运营商 | 最多45个字符。不能为空。 |
payment_method_country | 字符串 / “USA” | 支付方式所属国家。根据ISO 3166-1 alpha-3格式指定的国家 | 最多3个字符。不能为空。 |
billing_country | 字符串 / “USA” | 账单国家(付款所有者地址)。根据ISO 3166-1 alpha-3格式指定的国家 | 最多3个字符。不能为空。 |
billing_address | 字符串 / “111 First Street,Saratoga, CA 95070, US” | 账单地址(付款所有者地址) | 最多255个字符。不能为空。 |
服务器响应代码
查询的响应使用基本HTTP代码
代码 | 说明 | 响应内容 |
200 OK | 请求已处理 | |
400 BadRequest | 无效请求 | { error : “数据有问题” } |
401 Unauthorized | 未授权访问 | { error : “令牌无效。” } |
数字服务的示例查询:
控制台的示例请求
curl -v POST '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 ** * **", }'
商品
参数 | 类型/示例 | 示例说明 | 验证 |
transaction_id | 字符串/ 555-yyy | 交易ID | 最多255个字符。不能为空。 |
transaction_datetime | 日期时间 / 2017-01-09T08:27:22 +00:00 | 根据ISO 8601 GMT格式的交易日期和时间 | 不能为空。 |
transaction_sum | 字符串 / 25 | 交易金额 | 最多45个字符。不能为空。 |
currency |
字符串 / “GBP”, “EUR”, “RUB” |
所有货币均按照ISO 4217标准表示 | 最多3个字符。不能为空。 |
arrival_country | 字符串 / “GBR” | 根据ISO 3166-1 alpha-3格式的国家代码 | 最多3个字符。 |
arrival_city | 字符串 / “London” | 到达城市 | 最多255个字符。 |
arrival_address_line | 字符串 / “Peckham Road” | 到达地址 | 最多255个字符。 |
transaction_status |
字符串 / “Success”, “Charge back”, “refund”, “Movement own goods” |
交易状态 | 不能为空。 |
good_code | 字符串 / “62160000” | 根据欧盟的八位数字编码系统(合并命名法,CN)的商品代码 | 最多8个字符。 |
vat_percent | 浮点数 / 20.00 | 增值税百分比 | 最多8个字符。 |
vat | 浮点数 / 28.73 | 增值税金额 | 浮点数 |
departure_country | 字符串 / “AUS” | 根据ISO 3166-1 alpha-3格式的国家代码 | 最多3个字符。不能为空。 |
taxable_jurisdiction | 字符串 / “GBR” | 根据ISO 3166-1 alpha-3格式的国家代码 | 最多3个字符。 |
buyer_vat_number | 字符串 / “UK123123123” | 买方的欧盟增值税号码 | 最多255个字符。 |
商品的示例查询:
控制台示例请求
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", }'
服务代码列表
音频/视频内容 | 1 |
实时流媒体 | 2 |
电话服务 | 3 |
网络电话服务 | 4 |
呼叫管理服务 | 5 |
寻呼服务 | 6 |
互联网接入 | 7 |
图片 | 8 |
音乐 | 9 |
游戏 | 10 |
电子报纸 | 11 |
网站托管 | 12 |
程序的远程维护 | 13 |
网站广告空间 | 14 |
电子书 | 15 |
许可证 | 16 |
约会 | 17 |
远程教育 | 18 |
赌博 | 19 |
商品供应 | 20 |
其他数字服务 | 21 |