饲料 API
与 LOVAT 系统技术集成的说明
术语和缩写
API – 应用程序编程接口。 系统提供的一组调用用于与外部软件产品集成。
商家 – 在线商店的所有者。
客户 – 为商品或服务付费的个人。
交易 – 客户从商家收到的商品或服务的资金转移。
令牌 – 系统用来识别商家和注册交易的网站的秘密字符串。
接口说明
发送方法。
方法的描述。
SEND 方法实现交易数据的接收,同时考虑到增值税和系统费用的处理和计算。
引荐来源网址
该方法可在以下 URL 获得:
https://merchant.vatcompliance.co/api/1/
send/{access_token}?if_digital={true/false}&if_vat_calculate={true/false}
通话选项
调用参数分为两种:
- 路径参数(令牌)
- 查询参数(交易数据)
令牌是在添加网站的第一阶段在商家的内部帐户中生成的。 你可以从你的经理那里得到它,或者在分区商店 – 设置中找到它。
请求参数由商户生成,并在应用程序中使用POST方法发送到服务器
/ x-www-form-urlencoded or application / json format
数字服务
范围 | 类型/示例 | 示例 描述 | 验证 |
transaction_id | 字符串/ 555-yyy | 交易编号 | 最多 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 : “Problem with data” } |
401 Unauthorized | 越权存取 | { error : “Token is invalid.” } |
数字服务的示例查询:
来自控制台的示例请求
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 ** * **", }'
商品
范围 | 类型/示例 | 示例 描述 | 验证 |
transaction_id | 细绳/ 555-yyy | 交易编号 | 最多 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 |