Cost+Docs

Autorizacie, zachytenia a zrusenia

Sprava procesov autorizacie, zachytenia a zrusenia platieb

Niektore platobne metody podporuju dvojkrokovy proces: najprv autorizacia (rezervacia prostriedkov), potom zachytenie (strhnutie prostriedkov) alebo zrusenie (uvolnenie rezervacie).

Rezimy zachytenia

Nastavte capture_mode na objednavke na kontrolu, kedy sa prostriedky zachytia:

RezimSpravanie
manualZachytite explicitne, ked ste pripraveni (napr. po odoslani). Ak nezachytite pred exspiraciou objednavky, autorizacia sa strati a nemoze byt zachytena.
delayedProstriedky sa automaticky zachytia v momente uplynutia expiration_period.
POST /v1/orders/ (manualne zachytenie)
{
  "currency": "EUR",
  "amount": 5000,
  "capture_mode": "manual",
  "return_url": "https://www.example.com",
  "webhook_url": "https://www.example.com/webhook",
  "transactions": [
    {
      "payment_method": "credit-card"
    }
  ]
}

Pri manual zachyteni musite zachytit pred uplynutim obdobia exspiracie objednavky. Po exspiracii sa autorizacia uvolni a prostriedky nemozno zachytit. Nastavte vhodne expiration_period pre vas casovy harmonogram plnenia.

capture_mode mozete nastavit na urovni objednavky bez zadania transactions. Hostovana platobna stranka potom zobrazi len platobne metody, ktore podporuju zadany rezim zachytenia.

Kontrola sum dostupnych na zachytenie

Pred zachytenim mozete skontrolovat, kolko je dostupnych na zachytenie dotazom na amount_details:

curl -u YOUR_API_KEY: \
  "https://api.costplus.online/v1/orders/{order_id}/?fields[]=amount_details"

Odpoved obsahuje objekt amount_details:

{
  "amount": 5000,
  "amount_details": {
    "capturable": 5000,
    "captured": 0,
    "refundable": 0,
    "refunded": 0,
    "voidable": 5000,
    "voided": 0
  }
}

Polozky objednavky

Pri pouziti zachyteni a zruseni podla polozky objednavky pouzite tieto typy:

TypPopis
physicalFyzicky produkt
discountSuma zlavy
shipping_feeNaklady na dopravu
sales_taxDan z predaja
digitalDigitalny produkt
gift_cardDarcekova karta
store_creditKredit v obchode
surchargePrirazka

Zachytenie platieb

Zachytenie podla polozky objednavky

POST /v1/orders/{id}/transactions/{transaction_id}/captures/orderlines
Telo poziadavky
{
  "description": "Shipping item #1",
  "order_line": {
    "merchant_order_line_id": "item-001",
    "quantity": 1
  }
}

Zachytenie podla sumy

POST /v1/orders/{id}/transactions/{transaction_id}/captures/amount
Telo poziadavky
{
  "description": "Partial capture",
  "amount": 2500
}

Zrusenie platieb

Zrusenie uvolni autorizovane prostriedky spat zakaznikovi.

Zrusenie podla polozky objednavky

POST /v1/orders/{id}/transactions/{transaction_id}/voids/orderlines
Telo poziadavky
{
  "description": "Voiding item #2",
  "order_line": {
    "merchant_order_line_id": "item-002",
    "quantity": 1
  }
}

Zrusenie podla sumy

POST /v1/orders/{id}/transactions/{transaction_id}/voids/amount
Telo poziadavky
{
  "description": "Partial void",
  "amount": 1500
}

Parametre dotazu

Pridajte parametre dotazu na zahrnutie dalsich podrobnosti v odpovedi:

ParameterPopis
?fields[]=order_line_detailsZahrnutie rozpisov poloziek objednavky
?fields[]=amount_detailsZahrnutie rozpisov sum

Optimisticke zamykanie

Endpointy zachytenia a zrusenia podporuju optimisticke zamykanie na zaklade ETag cez hlavicku if-match. To zabranuje konfliktom pri sucastnom pokuse viacerych systemov o zachytenie tej istej transakcie.

Zachytenie s optimistickym zamykanim
curl -X POST https://api.costplus.online/v1/orders/{id}/transactions/{tid}/captures/amount \
  -u {api_key}: \
  -H "Content-Type: application/json" \
  -H "if-match: \"etag-value\"" \
  -d '{"description": "Capture", "amount": 2500}'

Ak ETag nesedi (objednavka bola zmenena od vasho posledneho ziskania), dostavate odpoved 412 Precondition Failed.

Cost+ podporuje jedno zachytenie na autorizaciu a zrusenia je mozne spracovat len pred akymkolvek zachytenim. Podla toho plánujte svoju strategiu zachytenia.

Suvisiace endpointy

On this page