Vytvoření faktury a provedení platby

Dokumentace: Práce s rozhraním API pro vytvoření faktury a provedení platby

---

1. Obecné informace

Rozhraní API umožňuje spravovat faktury: vytvářet nové faktury a provádět jejich platby.

Základní adresa URL: https://api.client.nbcgate.tech

---

2. Fáze práce

Krok 1: Vytvoření faktury

Metoda slouží k vytvoření nové faktury s uvedením částky, měny, produktu a dalších údajů.

Adresa URL požadavku: POST /invoice/create

Příklad dotazu (cURL):

curl -X 'POST' \
  'https://api.client.nbcgate.tech/invoice/create' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "amount": 100,
  "coin_id": 1,
  "id": 12345,
  "product_id": 67890
}'

Popis parametrů těla požadavku:

Pole	Typ	Popis	Příklad hodnoty
amount	number	Fakturovaná částka	100
coin_id	number	Identifikátor měny (např. 1 - USD)	1
id	number	Jedinečný identifikátor pay_link	12345
product_id	number	Identifikátor produktu	67890

Příklad odpovědi (JSON):

{
  "success": true,
  "invoice_id": 12345,
  "message": "Invoice created successfully"
}

Popis odpovědi:

• success (boolean): Stav transakce.

• invoice_id (number): Jedinečný identifikátor vytvořené faktury.

• message (string): Popis výsledku.

---

Krok 2. Provedení platby na základě faktury

Metoda se používá k úhradě dříve vytvořené faktury.

Adresa URL žádosti: POST /invoice/pay

Aktualizujme dokumentaci k metodě /invoice/pay, aby odrážela nový formát odpovědi.

---

Metoda: Provedení platby na základě faktury

Metoda se používá k úhradě dříve vytvořené faktury. Odpověď vrací informace o platbě, včetně adresy pro převod peněz, částky, provize a dalších údajů.

---

Adresa URL žádosti:

POST /invoice/pay

---

Příklad dotazu (cURL):

curl -X 'POST' \
  'https://api.client.nbcgate.tech/invoice/pay' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "idInvoice": 12345
}'

---

Tělo žádosti:

Pole	Typ	Povinné	Popis	Příklad hodnoty
idInvoice	number	Ano	Jedinečný identifikátor faktury	12345

---

Příklad úspěšné reakce:

{
  "address": "TRDkc3pmPnvYZ2UiDsmModEitJp7akTVyy",
  "amount": "444.274652",
  "rate": 0.116482,
  "name": "Tron Shasta Testnet",
  "code": "TRX"
}

---

Pole odpovědi Popis:

Pole	Typ	Popis
address	string	Adresa peněženky, do které chcete převést peníze.
amount	string	Převod částky v zadané kryptoměně.
rate	float64	Směnný kurz měny vůči základní měně faktury.
name	string	Název sítě kryptoměn (např. Tron Shasta Testnet).
code	string	Kód kryptoměny, v níž se převod provádí (např. TRX).
transferCommissionWeis*	float64	(Je-li k dispozici) Výše poplatku za převod v jednotkách kryptoměny.

*Pole TransferCommissionWeis může být povoleno v závislosti na nastavení API nebo kontextu požadavku.

---

Příklad použití odpovědi:

Jakmile dostanete odpověď, můžete:

1. Odeslání amount na address prostřednictvím vybrané kryptoměnové peněženky.

2. Zajistěte, aby byl použit správný kód měny (code) a síť (name)..

---

Zpracování chyb:

Kód odpovědi	Popis	Možné příčiny
400	Neplatný dotaz	Absence povinného parametru.
404	Faktura nebyla nalezena	Je zadáno neexistující idInvoice.
500	Interní chyba serveru	Problémy na straně serveru.

---

3. Úplný příklad provedení dvou dotazů

1. Vytvoření faktury:

   curl -X 'POST' \
     'https://api.client.nbcgate.tech/invoice/create' \
     -H 'accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '{
     "amount": 100,
     "coin_id": 1,
     "id": 12345,
     "product_id": 67890
   }'

   Výsledek:

   {
     "success": true,
     "invoice_id": 12345,
     "message": "Invoice created successfully"
   }

2. Proveďte platbu:

   curl -X 'POST' \
     'https://api.client.nbcgate.tech/invoice/pay' \
     -H 'accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '{
     "idInvoice": 12345
   }'

   Výsledek:

   {
     "success": true,
     "message": "Payment processed successfully"
   }

---

4. Chyby a jejich řešení

Při práci s rozhraním API může dojít k následujícím chybám:

Kód odpovědi	Popis	Možné příčiny
400	Neplatný dotaz	Chybějící povinné parametry.
404	Faktura nebyla nalezena	Je zadáno neexistující idInvoice.
500	Interní chyba serveru	Problémy na straně serveru.