Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

Function payment/export (http://<DOMAIN>/api/payment/export/)

Parameters:

  • token - authorization key received through the auth function

Response:

  • status - status of the function execution
    • OK - data exported
    • EMPTY - no data for export
  • response.payment - list of payment options
    • response.payment[i].id - unique identifier of payment option
    • response.payment[i].title - name of payment option
      • response.payment[i].title.ru - name of payment option in Russian language
      • response.payment[i].title.ua - name of payment option in Ukrainian language
      • ....
      • response.payment[i].title.<LN> - name of the payment option in the language. Where <LN> is the abbreviation of the language on the site
    • response.payment[i].desc - description of the payment option
      • response.payment[i].desc.ru - description of payment option in Russian language
      • response.payment[i].desc.ua - description of payment option in Ukrainian language
      • ....
      • response.payment[i].desc.<LN> - description of the payment option in the language. Where <LN> is the abbreviation of the language on the site
    • response.payment[i].payment_method - payment method identifier (see payment/exportMethods function)
    • response.payment[i].enabled - payment option enabled
    • response.payment[i].icon - link to payment option icon (for footer)
    • response.payment[i].link - link to payment gateway
    • response.payment[i].icon_title - icon description
      • response.payment[i].icon_title.ru - icon description in Russian language
      • response.payment[i].icon_title.ua - description of icon in Ukrainian language
      • ....
      • response.payment[i].icon_title.<LN> - description of the icon in the language. Where <LN> is the abbreviation of the language on the site
    • response.payment[i].payment_instruction - payment instruction
      • response.payment[i].payment_instruction.ru - payment instruction in Russian language
      • response.payment[i].payment_instruction.ua - payment instruction in Ukrainian language
      • ....
      • response.payment[i].payment_instruction.<LN> - payment instruction in language. Where <LN> is the abbreviation of the language on the site


Query example http://<DOMAIN>/api/payment/export/)
{  
    "token": "24a75d0678c49a34030e35baeb376ff3"
}
Response example
{
    "status": "OK",
    "response": {
        "payment": [
            {
                "id": 12,
                "title": {
                    "ru": "Безналичный расчет",
                    "ua": "Безготівковий розрахунок"
                },
                "desc": {
                    "ru": "",
                    "ua": ""
                },
                "payment_method": 1,
                "enabled": true,
                "icon": null,
                "link": "",
                "icon_title": {
                    "ru": "",
                    "ua": ""
                },
                "payment_instruction": {
                    "ru": "",
                    "ua": ""
                }
            },
            {
                "id": 13,
                "title": {
                    "ru": "Наличными",
                    "ua": "Готівкою"
                },
                "desc": {
                    "ru": "",
                    "ua": ""
                },
                "payment_method": 1,
                "enabled": true,
                "icon": null,
                "link": "",
                "icon_title": {
                    "ru": "",
                    "ua": ""
                },
                "payment_instruction": {
                    "ru": "",
                    "ua": ""
                }
            },
            {
                "id": 14,
                "title": {
                    "ru": "Онлайн-оплата кредитной картой",
                    "ua": "Онлайн-оплата кредитною карткою"
                },
                "desc": {
                    "ru": "",
                    "ua": ""
                },
                "payment_method": 2,
                "enabled": true,
                "icon": "http:\/\/my.horoshop.dev\/content\/images\/50\/34905029336611.jpg",
                "link": "https:\/\/liqpay.com",
                "icon_title": {
                    "ru": "Принимаем оплату Visa\/Mastercard через Liqpay",
                    "ua": "Принимаем оплату Visa\/Mastercard через Liqpay"
                },
                "payment_instruction": {
                    "ru": "",
                    "ua": ""
                }
            },
            {
                "id": 15,
                "title": {
                    "ru": "Оплата при получении",
                    "ua": "Післяплата"
                },
                "desc": {
                    "ru": "",
                    "ua": ""
                },
                "payment_method": 1,
                "enabled": true,
                "icon": null,
                "link": "",
                "icon_title": {
                    "ru": "",
                    "ua": ""
                },
                "payment_instruction": {
                    "ru": "",
                    "ua": ""
                }
            },
            {
                "id": 16,
                "title": {
                    "ru": "Приват24",
                    "ua": "Приват24"
                },
                "desc": {
                    "ru": "",
                    "ua": ""
                },
                "payment_method": 3,
                "enabled": true,
                "icon": "http:\/\/my.horoshop.dev\/content\/images\/11\/67169594599140.jpg",
                "link": "https:\/\/privat24.ua",
                "icon_title": {
                    "ru": "Принимаем оплату через Privat24",
                    "ua": "Принимаем оплату через Privat24"
                },
                "payment_instruction": {
                    "ru": "",
                    "ua": ""
                }
            },
            {
                "id": 17,
                "title": {
                    "ru": "PayPal",
                    "ua": "PayPal"
                },
                "desc": {
                    "ru": "",
                    "ua": ""
                },
                "payment_method": 4,
                "enabled": false,
                "icon": null,
                "link": "https:\/\/www.paypal.com\/",
                "icon_title": {
                    "ru": "PayPal",
                    "ua": "PayPal"
                },
                "payment_instruction": {
                    "ru": "",
                    "ua": ""
                }
            }
        ]
    }
}
  • No labels