Оплати

Деталізація вартості відправлень

🔗Початок роботи з API

Розшифрувати вартість ЕН (JSON)

post

Метод tlGetRecipientPaymentInfo моделі PaymentGeneral використовується для розшифрування вартості експрес-накладної (ЕН) відповідно до наданих послуг.

Body

apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:

calledMethodstring · enumRequired

Назва методу API

Possible values:

Responses

200

Успішна відповідь (JSON)

application/json

successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/

POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 213

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "PaymentGeneral",
  "calledMethod": "tlGetRecipientPaymentInfo",
  "methodProperties": {
    "Language": "ua",
    "Document": "59000661066154",
    "pays": [
      {
        "paycode": "38130410",
        "paysum": 2488
      }
    ]
  }
}

200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Number": "59000661066154",
      "Services": "0",
      "AfterPayment": "0",
      "MoneyTransfer": "0",
      "Commission": "0",
      "ServicesPaid": "76",
      "AfterPaymentPaid": "0",
      "MoneyTransferPaid": "1142",
      "TotalServices": "76",
      "TotalAfterPayment": "0",
      "TotalMoneyTransfer": "1142",
      "Cash2CardPayout_Id": "00000000-0000-0000-0000-000000000000",
      "Cash2CardSource": "cashdesk",
      "SecurePayment": "false",
      "PaymentPromocode": "false",
      "InternationalDelivery": "0",
      "InternationalDeliveryPaid": "0",
      "TotalInternationalDelivery": "0",
      "ServicesList": [
        {
          "Service": "00000000-0000-0000-0000-000000000000",
          "ServiceName": "Доставка посилок по Україні",
          "Amount": "3",
          "Cost": "55",
          "RoundCost": "55",
          "Paid": "55",
          "ServiceType": "Services",
          "OperationType": "PaymentForServices"
        },
        {
          "Service": "00000000-0000-0000-0000-000000000000",
          "ServiceName": "Пакування відправлення",
          "Amount": "1",
          "Cost": "15",
          "RoundCost": "15",
          "Paid": "15",
          "ServiceType": "Services",
          "OperationType": "PaymentForServices"
        },
        {
          "Service": "00000000-0000-0000-0000-000000000000",
          "ServiceName": "Комісія від оголошеної вартості",
          "Amount": "1100",
          "Cost": "6",
          "RoundCost": "6",
          "Paid": "6",
          "ServiceType": "Services",
          "OperationType": "PaymentForServices"
        }
      ],
      "PaymentLoyalty": "false",
      "ServiceType": "WarehouseWarehouse",
      "WarehouseRecipientRef": "00000000-0000-0000-0000-000000000000",
      "UseNovaPay": "null",
      "ServicesListMoneyTransfer": [
        {
          "Service": "00000000-0000-0000-0000-000000000000",
          "ServiceName": "Грошовий переказ",
          "Amount": "0",
          "Paid": "1100",
          "Cost": "1100"
        },
        {
          "Service": "00000000-0000-0000-0000-000000000000",
          "ServiceName": "Комісія",
          "Amount": "0",
          "Paid": "42",
          "Cost": "42"
        }
      ],
      "CommissionPaid": "0"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Розшифрувати вартість ЕН (XML)

post

Метод tlGetRecipientPaymentInfo моделі PaymentGeneral дозволяє отримати розшифрування вартості експрес-накладної (ЕН) у форматі XML.

Body

apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:

calledMethodstring · enumRequired

Назва методу API

Possible values:

Responses

200

Успішна відповідь (XML)

application/xml

successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/

POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 491

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>PaymentGeneral</modelName>
    <calledMethod>tlGetRecipientPaymentInfo</calledMethod>
    <methodProperties>
        <Language>ua</Language>
        <Document>59000661066154</Document>
        <pays>
            <item>
                <paycode>38130410</paycode>
                <paysum>2488</paysum>
            </item>
        </pays>
    </methodProperties>
</file>
"

200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
            <Number>59000661066154</Number>
            <Services>0</Services>
            <AfterPayment>0</AfterPayment>
            <MoneyTransfer>0</MoneyTransfer>
            <Commission>0</Commission>
            <ServicesPaid>76</ServicesPaid>
            <AfterPaymentPaid>0</AfterPaymentPaid>
            <MoneyTransferPaid>1142</MoneyTransferPaid>
            <TotalServices>76</TotalServices>
            <TotalAfterPayment>0</TotalAfterPayment>
            <TotalMoneyTransfer>1142</TotalMoneyTransfer>
            <Cash2CardPayout_Id>00000000-0000-0000-0000-000000000000</Cash2CardPayout_Id>
            <Cash2CardSource>cashdesk</Cash2CardSource>
            <SecurePayment>false</SecurePayment>
            <PaymentPromocode>false</PaymentPromocode>
            <InternationalDelivery>0</InternationalDelivery>
            <InternationalDeliveryPaid>0</InternationalDeliveryPaid>
            <TotalInternationalDelivery>0</TotalInternationalDelivery>
            <ServicesList>
                <item>
                    <Service>00000000-0000-0000-0000-000000000000</Service>
                    <ServiceName>Доставка посилок по Україні</ServiceName>
                    <Amount>3</Amount>
                    <Cost>55</Cost>
                    <RoundCost>55</RoundCost>
                    <Paid>55</Paid>
                    <ServiceType>Services</ServiceType>
                    <OperationType>PaymentForServices</OperationType>
                </item>
                <item>
                    <Service>00000000-0000-0000-0000-000000000000</Service>
                    <ServiceName>Пакування відправлення</ServiceName>
                    <Amount>1</Amount>
                    <Cost>15</Cost>
                    <RoundCost>15</RoundCost>
                    <Paid>15</Paid>
                    <ServiceType>Services</ServiceType>
                    <OperationType>PaymentForServices</OperationType>
                </item>
                <item>
                    <Service>00000000-0000-0000-0000-000000000000</Service>
                    <ServiceName>Комісія від оголошеної вартості</ServiceName>
                    <Amount>1100</Amount>
                    <Cost>6</Cost>
                    <RoundCost>6</RoundCost>
                    <Paid>6</Paid>
                    <ServiceType>Services</ServiceType>
                    <OperationType>PaymentForServices</OperationType>
                </item>
            </ServicesList>
            <PaymentLoyalty>false</PaymentLoyalty>
            <ServiceType>WarehouseWarehouse</ServiceType>
            <WarehouseRecipientRef>00000000-0000-0000-0000-000000000000</WarehouseRecipientRef>
            <UseNovaPay>null</UseNovaPay>
            <ServicesListMoneyTransfer>
                <item>
                    <Service>00000000-0000-0000-0000-000000000000</Service>
                    <ServiceName>Грошовий переказ</ServiceName>
                    <Amount>0</Amount>
                    <Paid>1100</Paid>
                    <Cost>1100</Cost>
                </item>
                <item>
                    <Service>00000000-0000-0000-0000-000000000000</Service>
                    <ServiceName>Комісія</ServiceName>
                    <Amount>0</Amount>
                    <Paid>42</Paid>
                    <Cost>42</Cost>
                </item>
            </ServicesListMoneyTransfer>
            <CommissionPaid>0</CommissionPaid>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>