Skip to content

Ahoj API Endpointy

Jump to bottom
chaossme edited this page Aug 2, 2022 · 2 revisions

Pre identifikáciu parametrov komplexných dátových typov služieb sa používa bodková notácia v tvare: param1.param2.param3 Param1 je objekt najvyššej úrovne, ktorý sa skladá z podobjektu param2, ktorý sa skladá z podobjektu/parametra param3.

param1: {
    param2: {
        param3 : // primitívny dátový typ
    }
}

Payment-methods

[GET] /eshop/{businessPlace}/product/payment-methods

Metóda sa volá pri inicializácii Ahoj.js JavaScript knižnice. Volanie metódy vráti zoznam platobných metód dostupných pre integrátora. Výstupný objekt obsahuje parametre služby ktoré definujú obchodné podmienky.

Vstupné parametre

Názov Typ Popis Povinný
API_KEY header Autorizačný kľúč predajného miesta Áno
businessPlace path Identifikátor pre predajné miesto služby Ahoj platby Áno

Návratová hodnota

Array of PaymentMethod : Objekt reprezentuje platobnú metódu dostupnú pre integrátora v rámci Ahoj platby.

Objekt PaymentMethod

Názov Typ Popis
code string Kód platobnej metódy
name string Názov platobnej metódy
title string Nadpis platobnej metódy zobrazovaný v eshop košíku
promotions array of Promotion Zoznam všetkých produktov/akcií platobnej metódy
description string Jednoduchý textový popis platobnej metódy
descriptionHtml string Formátovaný - HTML popis platobnej metódy

Príklad volania:

GET /eshop/TEST_SHOP/product/payment-methods
Content-Type: */*
Accept: application/json
API_KEY: example123apikey

Príklad návratovej hodnoty:

[
  {
    "code": "DEFERRED_PAYMENT",
    "name": "Odlož.to",
    "title": "Ahoj - platba o 30 dní bez navýšenia",
    "promotions": [
      {
        "code": "DP_DEFER_IT",
        "name": "Zaplať o 30 dní",
        "description": "Nakúp teraz, splať o 30 dní",
        "instalmentIntervalDays": 30,
        "minGoodsPrice": 10.0,
        "minGoodsItemPrice": 2.0,
        "maxGoodsPrice": 300.0,
        "maxGoodsPriceProspect": 300.0,
        "deposit": {
          "from": 0.0,
          "to": 0.0,
          "step": 0.0
        },
        "depositPercent": {
          "from": 0.0,
          "to": 0.0,
          "step": 0.0
        },
        "instalmentCount": {
          "from": 1,
          "to": 1,
          "step": 1
        },
        "loanAmount": {
          "from": 10.0,
          "to": 350.0
        },
        "productType": {
          "code": "GOODS_DEFERRED_PAYMENT",
          "name": "Kúp teraz, zaplať neskôr"
        }
      }
    ]
  },
  {
    "code": "SPLIT_PAYMENT",
    "name": "Rozlož.to",
    "title": "Ahoj - v 3 platbách bez navýšenia",
    "promotions": [
      {
        "code": "SP_SPLIT_IT",
        "name": "rozlož to",
        "description": "3 bezúročné platby",
        "instalmentIntervalDays": 1,
        "minGoodsPrice": 50.0,
        "minGoodsItemPrice": 20.0,
        "maxGoodsPrice": 300.0,
        "maxGoodsPriceProspect": 300.0,
        "deposit": {
          "from": 0.0,
          "to": 0.0,
          "step": 0.0
        },
        "depositPercent": {
          "from": 0.0,
          "to": 0.0,
          "step": 0.0
        },
        "instalmentCount": {
          "from": 3,
          "to": 3,
          "step": 1
        },
        "loanAmount": {
          "from": 20.0,
          "to": 350.0
        },
        "productType": {
          "code": "GOODS_SPLIT_PAYMENT",
          "name": "Rozlož to",
          "instalmentDayOfMonth": 20
        }
      }
    ]
  }
]

Calculation

[POST] /eshop/{businessPlace}/calculation

Metóda slúži na výpočet plnej sady finančných parametrov úveru bez navýšenia na základe zvolených vstupných parametrov. Používa sa pre zobrazenie splátok metódy Ahoj platby „v 3 platbách bez navýšenia“.

Vstupné parametre

Názov Typ Popis Povinný
API_KEY header Autorizačný kľúč predajného miesta Áno
businessPlace path Identifikátor pre predajné miesto služby Ahoj platby Áno

Telo volania (Vstupné parametre pre výpočet bezúročného úveru)

Ide primárne o vstupné údaje potrebné pre výpočet ďalších parametrov produktu.

Názov Typ Popis Povinný
depositAmount number Výška akontácie v € (Default hodnota 0.00 € ) Áno
instalmentCount number Počet mesačných splátok z objektu PaymentMethod, ktorý je výsledkom volania payment-methods (GET) Áno
promotion.code string Kód akcie z objektu PaymentMethod, ktorý je výsledkom volania payment-methods (GET) Áno
goods.price number Konečná kúpna cena (tovaru / služieb / objednávky bez dopravy ak je táto mapovaná v goodsDeliveryCosts) s DPH zaokrúhlená na € centy Áno
goodsDeliveryCosts number Konečná kúpna cena doručovacích nákladov objednávky s DPH zaokrúhlená na € centy Áno

Návratová hodnota

CalculatedProduct: Objekt reprezentuje finančné parametre pre zvolený produkt Ahoj platby. Ide o rozšírenie triedy Produktu o parametre, ktoré sú výstupom kalkulácie.

Príklad volania:

POST /eshop/TEST_SHOP/calculation
Content-Type: application/json
Accept: application/json
API_KEY: example123apikey

{
  {
  "depositAmount" : 0,
  "instalmentCount" : 3,
  "promotion" : {
    "code" : "SP_SPLIT_IT"
  },
  "goods" : [ {
    "price" : 200
  } ],
  "goodsDeliveryCosts" : 10,
}
}

Príklad návratovej hodnoty:

[
  {
    "amount": 210,
    "depositAmount": 0,
    "depositPercent": 0.0000,
    "instalmentCount": 3,
    "promotion": {
        "code": "SP_SPLIT_IT",
        "name": "Kúp teraz, zaplať v 3 platbách",
        "description": "Nakúp teraz, zaplať v 3 bezúročných platbách",
        "instalmentIntervalDays": 15,
        "minGoodsPrice": 50.0,
        "minGoodsItemPrice": 20.0,
        "maxGoodsPrice": 300.0,
        "maxGoodsPriceProspect": 300.0,
        "productType": {
            "code": "GOODS_SPLIT_PAYMENT",
            "name": "Rozlož to",
            "instalmentDayOfMonth": 20
        }
    },
    "goods": [
        {
            "price": 200,
            "totalPrice": 200
        }
    ],
    "instalment": {
        "amount": 70.00,
        "amountWithInsurance": 70.00,
        "insuranceAmount": 0
    },
    "goodsDeliveryCosts": 10,
    "averageRpmn": 0,
    "interest": 0.0000,
    "maxReward": 0,
    "reward": 0.0000,
    "rpmn": 0.0000,
    "totalAmount": 210.00,
    "totalAmountWithInsurance": 210.00,
    "totalCosts": 0.00
}
]

Application

[POST] /eshop/application

Metóda slúži na vytvorenie žiadosti o bezúročný úver zo strany integrátora pre financovanie objednávky prostredníctvom služby Ahoj platby. Integrátor volá službu následne po potvrdení objednávky Zákazníkom na obrazovke „Výber platby v E-shope“.

Vstupom do metódy sú fakturačné údaje Zákazníka, zoznam objednaných tovarov a služieb vrátane počtu kusov a jednotkových cien, cien prípadných doplnkových služieb k tovarom a poplatkami spojenými s doručením tovaru. Služba Ahoj platby vyžaduje aby objednaný tovar bol doručený jednorázovo (t.j. nesmie byť rozdelený do viacerých dodávok).

Vstupné parametre

Názov Typ Popis Povinný
API_KEY header Autorizačný kľúč predajného miesta Áno

Telo volania

Názov Popis Typ Povinný
businessPlace Identifikátor pre predajné miesto služby Ahoj platby string Áno
orderNumber Číslo objednávky E-shopu string Áno
customer Komplexný dátový typ zahŕňajúci informácie o zákazníkovi (rozdelený do jednotlivých polí) Customer Áno
customer.firstName Meno zákazníka (Hodnota je automaticky normalizovaná na strane Ahoj Shoppingového formulára na prvé veľké písmeno v samostatnom slove) string Áno
customer.lastName Priezvisko zákazníka (Hodnota je automaticky normalizovaná na strane Ahoj Shoppingového formulára na prvé veľké písmeno v samostatnom slove) string Áno
customer.contactInfo.email Kontaktný e-mail zákazníka (Validačné pravidl: Email klienta) string Áno
customer.contactInfo.mobile Kontaktné mobilné číslo zákazníka (Validačné pravidlo: Mobilné telefónne číslo klienta) string Áno
customer.permanentAddress.street názov ulice z fakturačnej adresy. V prípade ak E- shop neparsuje čísla ulice, je možné ich uviesť v tomto parametri string Áno
customer.permanentAddress.registerNumber Súpisné číslo domu z fakturačnej adresy (Validácia čísla – napr. 3) string Nie
customer.permanentAddress.referenceNumber Orientačné číslo domu z fakturačnej adresy (Validácia čísla aj písmená – napr. 1A) string Áno (Nepovinné ak je súčasťou parametra
customer.permanentAddress.city Názov obce z fakturačnej adresy string Áno
customer.permanentAddress.zipCode Poštové smerovacie číslo z fakturačnej adresy (Validácia na povinných 4 alebo 5 číselných znakov bez medzier) string Áno
customer.permanentAddress.country.code Kód krajiny fakturačnej adresy v ISO 3166-1 Alpha-2 formáte (2 znaky - napr. SK) string Áno
product.depositAmount Výška akontácie v € (Default hodnota 0.00 € ) number Áno
product.instalmentCount Počet mesačných splátok z objektu PaymentMethod, ktorý je výsledkom volania payment-methods (GET) number Áno
product.promotion.code Kód akcie z objektu Promotion, ktorý je výsledkom volania payment-methods (GET) string Áno
product.goodsDeliveryTypeText Kód, prípadne názov e-shop spôsobu doručenia objednávky string Nie
product.goodsDeliveryAddress Komplexný dátový typ zahŕňajúci informácie o doručovacej adrese (rozdelený do jednotlivých polí). V prípade, že nie je tento parameter vyplnený použije sa fakturačná adresa string Nie
product.goodsDeliveryAddress.name Pomenovanie miesta doručenia string Nie
product.goodsDeliveryAddress.street Názov ulice z doručovacej adresy. V prípade ak E-shop neparsuje čísla ulice, je možné ich uviesť v tomto parametri string Nie
product.goodsDeliveryAddress.registerNumber Súpisné číslo domu doručovacej adresy (Validácia čísla – napr. 3) string Nie
product.goodsDeliveryAddress.referenceNumber Orientačné číslo domu z fakturačnej adresy (Validácia čísla aj písmená – napr. 1A) string nie (ak bolo uvedené pri goodsDeliveryAddress.street)
product.goodsDeliveryAddress.city Názov obce doručovacej adresy string Nie
product.goodsDeliveryAddress.zipCode Poštové smerovacie číslo doručovacej adresy (Validácia na povinných 4 alebo 5 číselných znakov bez medzier) string Nie
product.goodsDeliveryAddress.country ISO 3166-1 Alpha-2 kód krajiny doručovacej adresy string Nie
product.goods[] Komplexný dátový typ zahŕňajúci informácie o tovare rozdelený do jednotlivých polí) Product Áno
product.goods[].name Názov tovaru string Áno
product.goods[].price Jednotková cena tovaru v EUR s DPH zaokrúhlená na € centy (najviac 2 desatinné miesta), v ktorej sú zohľadnené všetky poskytnuté zľavy vrátane zľavových kupónov na danú položku decimal number Áno
product.goods[].id Jednoznačný identifikátor tovaru na E-shope string Nie
product.goods[].codeText Kódové označenie tovarovej položky (EAN, ISBN, ISSN ...) string Nie
product.goods[].typeText Zrozumiteľný kód, názov, prípadne identifikátor typu tovarovej položky - tovar, služba, prepravné náklady, darčeková poukážka, zľavový kupón, objemová zľava, nešpecifikovaná položka a pod. string Nie
product.goods[].commodityText Kategória produktu (napr. z Heureka portálu) string Nie
product.goods[].nonMaterial Informácia o tom či je produkt nehmotný/virtuálny napr. nákupná poukážka, SW licencia a iné (boolean - hodnota „true“ ak je produkt nehmotný/virtuálny, inak „false“) Nie
product.goods[].count Počet objednaných kusov toho istého typu tovaru integer number (nezáporné celé číslo) Áno
product.goods[].additionalServices[] Komplexný dátový typ zahŕňajúci informácie o doplnkových službách k tovaru (rozdelený do jednotlivých polí) Nie
product.goods[].additionalServices[].id Jednoznačný identifikátor doplnkovej služby string Nie
product.goods[].additionalServices[].name Názov doplnkovej služby string Áno
product.goods[].additionalServices[].price Cena doplnkovej služby v EUR s DPH zaokrúhlená na € centy (najviac 2 desatinné miesta), v ktorej sú zohľadnené všetky poskytnuté zľavy vrátane zľavových kupónov na danú položku string Áno
product.goods[].additionalServices[].typeText Zrozumiteľný kód, názov, prípadne identifikátor typu doplnkovej služby – poistenie, predĺžená záruka, montáž a pod. string Nie
product.goodsDeliveryCosts Cena nákladov na dopravu tovaru v EUR s DPH zaokrúhlená na € centy (najviac 2 desatinné miesta), v ktorej sú zohľadnené všetky poskytnuté zľavy vrátane zľavových kupónov decimal number Áno
salesChannel "ESHOP" - defaultná hodnota string Áno
eshopWeb Informácia o doménovom mene webového sídla eshopu string Áno
eshopRegisteredCustomer Príznak registrovaného klienta e-shopu, nastavený na hodnotu „true“ ak eshop objednávku vypĺňal prihlásený registrovaný zákazník. boolean Nie
eshopCustomerOrderCount Počet predošlých úspešných nákupov klienta na danom E-shope (úspešný nákup = klientom uhradená a prevzatá objednávka, ktorá nebola následne vrátená), celé, nezáporné číslo, prvý nákup klienta = 0 number Nie
notificationCallbackUrl URL adresa notifikačného endpointu na strane partnera/predajne určená na notifikáciu pri zmene stavov žiadosti. string Nie

Návratová hodnota

ApplicationInfo : Objekt reprezentuje skrátené vybrané informácie o žiadosti.

Príklad volania:

POST /eshop/application
Content-Type: application/json
Accept: application/json
API_KEY: example123apikey

{
  "product": {
    "depositAmount" : 0,
    "instalmentCount" : 1,
    "promotion": {
      "code": "DP_DEFER_IT",
    },
    "goods": [
      {
        "id": "2",
        "name": "Fantastic Soft Tuna",
        "count": "1",
        "price": "10.33",
        "additionalServices": [
          {
            "id": "1",
            "name": "Insurrance",
            "price": "9.99"
          },
          {
            "id": "2",
            "name": "Quick repair",
            "price": "19.99"
          },
          {
            "id": "3",
            "name": "Extended warranty",
            "price": "29.99"
          }
        ]
      },
      {
        "id": "1",
        "name": "Fantastic Concrete Chips",
        "count": "2",
        "price": "5.19"
      }
    ],
    "goodsDeliveryAddress": {
      "city": "Senica",
      "country": {
        "code": "SK",
        "name": "Slovakia"
      },
      "name": "Home",
      "referenceNumber": "56",
      "registerNumber": "1234",
      "street": "Hviezdoslavova",
      "zipCode": "90501"
    },
    "goodsDeliveryCosts": 0,
    "goodsDeliveryTypeText": "local_pickup"
  },
  "customer": {
    "contactInfo": {
      "email": "dev1638366509@ahoj.shopping",
      "mobile": "+421 123 456 789"
    },
    "firstName": "John",
    "lastName": "Doe",
    "permanentAddress": {
      "city": "Bratislava",
      "country": {
        "code": "SK",
        "name": "Slovakia"
      },
      "referenceNumber": "56",
      "registerNumber": "12345",
      "street": "Hviezdoslavova",
      "zipCode": "81103"
    }
  },
  "businessPlace": "TEST_ESHOP",
  "eshopRegisteredCustomer": false,
  "eshopCustomerOrderCount": 2,
  "orderNumber": "ade52117-3d33-4eb0-bf4a-4c9d8087920b",
  "notificationCallbackUrl": "http://localhost:3000/notification",
  "salesChannel": "ESHOP",
  "eshopWeb": "www.eshop.sk"
}

Príklad návratovej hodnoty:

{
    "businessPlace": "TEST_ESHOP",
    "contractNumber": "2112000106",
    "orderNumber": "e5873cef-fbc7-4d47-a0ca-9dd86b875a6e",
    "product": {
        "amount": 147.76,
        "depositAmount": 0,
        "depositPercent": 0.0000,
        "instalmentCount": 1,
        "promotion": {
            "code": "DP_DEFER_IT",
            "name": "Zaplať o 30 dní",
            "description": "Nakúp teraz, splať o 30 dní",
            "instalmentIntervalDays": 30,
            "minGoodsPrice": 10.0,
            "minGoodsItemPrice": 2.0,
            "maxGoodsPrice": 300.0,
            "maxGoodsPriceProspect": 300.0,
            "deposit": {
                "from": 0.0,
                "to": 0.0,
                "step": 0.0
            },
            "depositPercent": {
                "from": 0.0,
                "to": 0.0,
                "step": 0.0
            },
            "instalmentCount": {
                "from": 1,
                "to": 1,
                "step": 1
            },
            "loanAmount": {
                "from": 10.0,
                "to": 350.0
            },
            "productType": {
                "code": "GOODS_DEFERRED_PAYMENT",
                "name": "Kúp teraz, zaplať neskôr"
            }
        },
        "goods": [
            {
                "name": "Incredible Steel Towels",
                "price": 24.31,
                "totalPrice": 24.31,
                "id": "5",
                "count": 1,
                "displayValue": "Incredible Steel Towels"
            }
        ],
        "instalment": {
            "amount": 147.76,
            "amountWithInsurance": 147.76,
            "insuranceAmount": 0
        },
        "goodsDeliveryCosts": 123.45,
        "goodsDeliveryAddress": {
            "name": "Home",
            "city": "Bratislava",
            "referenceNumber": "123/45",
            "registerNumber": "1",
            "street": "Bottova",
            "zipCode": "81109",
            "country": {
                "code": "SK",
                "name": "Slovenská republika"
            }
        },
        "goodsDeliveryTypeText": "local_pickup"
    },
    "state": "DRAFT",
    "customer": {
        "firstName": "Test",
        "lastName": "Customer",
        "contactInfo": {
            "email": "example@example.com",
            "mobile": "421912345678"
        },
        "permanentAddress": {
            "city": "Bratislava",
            "referenceNumber": "123/45",
            "registerNumber": "1",
            "street": "Bottova",
            "zipCode": "81109",
            "country": {
                "code": "SK",
                "name": "Slovenská republika"
            }
        }
    }
}

Application-url

[GET] /eshop/application/{contractNumber}/application-url

Metóda slúžiaca na získanie URL linky pre zobrazenie formulára žiadosti o úver.

Vstupné parametre

Názov Typ Popis Povinný
API_KEY header Autorizačný kľúč predajného miesta Áno
contractNumber path Číslo zmluvy resp. žiadosti Áno
completionUrl query URL odkaz definovaný E-shopom, na ktorý má byť Zákazník presmerovaný v prípade úspešného poskytnutia služby Nie
earlyTerminationUrl query URL odkaz definovaný E-shopom, na ktorý má byť Zákazník presmerovaný v prípade neposkytnutia služby Nie

Návratová hodnota

String applicationJson: URL link pre zobrazenie iframe formuláru

Príklad volania:

GET /eshop/application/1234354433/application-url
Content-Type: */*
Accept: application/json
API_KEY: example123apikey
completionUrl : "https://eshop.com/application/complete/"
earlyTerminationUrl : "https://eshop.com/application/terminadted/"

Príklad návratovej hodnoty:

https://eshop.test.psws.xyz/dp/ziadost/2112000108?cn=2112000108&cislooz=TEST_ESHOP&sign=B4143920DF57347D&earlyTerminationUrl=%2F&completionUrl=%2F

Application-info

[GET] /eshop/application/{contractNumber}

Metóda slúžiaca na získanie základných informácií o žiadosti a jej stave spracovania.

Vstupné parametre

Názov Typ Popis Povinný
API_KEY header Autorizačný kľúč predajného miesta Áno
contractNumber path Číslo zmluvy resp. žiadosti Áno

Návratová hodnota

Objekt ApplicationInfo : Skrátené vybrané informácie o žiadosti, ktorých súčasťou je atribút ApplicationInfo.state - stav žiadosti/zmluvy (číselník ContractState),

Hodnota contractState Popis Ukončenie procesu Akcia integrátora
DRAFT Rozpracovaná - Spracováva sa Ahoj platba Nie Počkať na dokončenie procesu poskytnutia Ahoj platby klientovi
SENT Odoslaná - Spracováva sa Ahoj platba Nie Počkať na dokončenie procesu poskytnutia Ahoj platby klientovi
APPROVED Schválená žiadosť - Spracováva sa Ahoj platba (klientom ešte nepodpísaná zmluva o úvere) Nie Počkať na dokončenie procesu poskytnutia Ahoj platby klientovi (tovar nie je možné ešte expedovať)
REJECTED Zamietnutá - Ahoj platba Áno Ponuka iného spôsobu platby klientovi
DELETED Zmazaná - Ahoj platba Áno Ponuka iného spôsobu platby klientovi
CANCELLED Zrušená - Ahoj platba Áno Ponuka iného spôsobu platby klientovi
SIGNED Podpísaná - Potvrdená Ahoj platba Áno Expedovať tovar

Príklad volania:

GET /eshop/application/1234354433
Content-Type: */*
Accept: application/json
API_KEY: example123apikey

Príklad návratovej hodnoty:

{
    "businessPlace": "TEST_ESHOP",
    "contractNumber": "2203000028",
    "orderNumber": "6691703e-74b2-4b5e-9619-38d81931d7af",
    "product": {
        "amount": 42.0,
        "depositAmount": 0,
        "depositPercent": 0.0000,
        "instalmentCount": 1,
        "promotion": {
            "code": "DP_DEFER_IT",
            "name": "Zaplať o 30 dní",
            "description": "Nakúp teraz, splať o 30 dní",
            "instalmentIntervalDays": 30,
            "minGoodsPrice": 10.0,
            "minGoodsItemPrice": 2.0,
            "maxGoodsPrice": 300.0,
            "maxGoodsPriceProspect": 300.0,
            "deposit": {
                "from": 0.0,
                "to": 0.0,
                "step": 0.0
            },
            "depositPercent": {
                "from": 0.0,
                "to": 0.0,
                "step": 0.0
            },
            "instalmentCount": {
                "from": 1,
                "to": 1,
                "step": 1
            },
            "loanAmount": {
                "from": 10.0,
                "to": 350.0
            },
            "productType": {
                "code": "GOODS_DEFERRED_PAYMENT",
                "name": "Kúp teraz, zaplať neskôr"
            }
        },
        "goods": [
            {
                "name": "Rustic Steel Car",
                "price": 10.5,
                "totalPrice": 42.0,
                "id": "2",
                "count": 4,
                "displayValue": "Rustic Steel Car"
            }
        ],
        "instalment": {
            "amount": 42.00,
            "amountWithInsurance": 42.00,
            "insuranceAmount": 0
        },
        "goodsDeliveryCosts": 0,
        "goodsDeliveryAddress": {
            "name": "Home",
            "city": "Senica",
            "referenceNumber": "56",
            "registerNumber": "1234",
            "street": "Hviezdoslavova",
            "zipCode": "90501",
            "country": {
                "code": "SK",
                "name": "Slovenská republika"
            }
        },
        "goodsDeliveryTypeText": "local_pickup"
    },
    "state": "DRAFT",
    "customer": {
        "firstName": "John",
        "lastName": "Doe",
        "contactInfo": {
            "email": "dev1638366509@ahoj.shopping",
            "mobile": "421 123 456 789"
        },
        "permanentAddress": {
            "city": "Bratislava",
            "referenceNumber": "56",
            "registerNumber": "12345",
            "street": "Hviezdoslavova",
            "zipCode": "81103",
            "country": {
                "code": "SK",
                "name": "Slovenská republika"
            }
        }
    }
}

Application-info podľa eshopOrderNumber

[GET] /eshop/{businessPlace}/order/{eshopOrderNumber}

Metóda slúžiaca na získanie základných informácií o žiadosti a jej stave spracovania podľa čísla objednávky.

Vstupné parametre

Názov Typ Popis Povinný
API_KEY header Autorizačný kľúč predajného miesta Áno
businessPlace path Identifikátor pre predajné miesto služby Ahoj platby Áno
eshopOrderNumber path Číslo objednávky z eshopu. Áno

Návratová hodnota

Objekt ApplicationInfo : Skrátené vybrané informácie o žiadosti, ktorých súčasťou je atribút ApplicationInfo.state - stav žiadosti/zmluvy (číselník ContractState),

Príklad návratovej hodnoty:

rovnaký ako pri application-info (GET)

Chybové odpovede

Kód Podmienka Typ
500 Server Error Error (JSON)
400 Bad Request Error (JSON)

Error (JSON) objekt

Názov Typ Popis
code string kód chyby
message string popis chyby

  1. Úvod
  2. Inštalácia a inicializácia
  3. Zobrazenie produktového banneru
  4. Zobrazenie platobných metód
  5. Vytvorenie objednávky a Ahoj žiadosti
  6. Notifikačné rozhranie notificationCallbackUrl
  7. Získanie informácií o stave žiadosti
  8. Ahoj API Endpointy
  9. Ahoj.js metódy
  10. Dátové typy
  11. Validačné pravidlá
Clone this wiki locally