Avtorizacije, zajemi in razveljavitve
Upravljanje tokov avtorizacije, zajema in razveljavitve plačil
Nekatere plačilne metode podpirajo dvostopenjski tok: najprej avtorizirajte (rezervirajte sredstva), nato zajemite (poberite sredstva) ali razveljavite (sprostite rezervacijo).
Načini zajema
Nastavite capture_mode na naročilu za nadzor, kdaj so sredstva zajeta:
| Način | Obnašanje |
|---|---|
manual | Izrecno zajemite, ko ste pripravljeni (npr. po pošiljanju). Če ne zajemete pred potekom naročila, je avtorizacija izgubljena in je ni mogoče zajeti. |
delayed | Sredstva so samodejno zajeta v trenutku, ko poteče expiration_period. |
{
"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 zajemu morate zajeti pred potekom obdobja veljavnosti naročila. Ko poteče, je avtorizacija sproščena in sredstev ni mogoče zajeti. Nastavite primerno expiration_period za vaš časovni okvir izpolnjevanja.
capture_mode lahko nastavite na ravni naročila brez navedbe transactions. Gostovana plačilna stran bo nato prikazala samo plačilne metode, ki podpirajo navedeni način zajema.
Preverjanje razpoložljivih zneskov za zajem
Pred zajemom lahko preverite, koliko je na voljo za zajem z zahtevo amount_details:
curl -u YOUR_API_KEY: \
"https://api.costplus.online/v1/orders/{order_id}/?fields[]=amount_details"Odgovor vključuje objekt amount_details:
{
"amount": 5000,
"amount_details": {
"capturable": 5000,
"captured": 0,
"refundable": 0,
"refunded": 0,
"voidable": 5000,
"voided": 0
}
}Postavke naročila
Pri uporabi zajemov in razveljavitev po postavkah naročila uporabite te tipe:
| Tip | Opis |
|---|---|
physical | Fizični izdelek |
discount | Znesek popusta |
shipping_fee | Stroški pošiljanja |
sales_tax | Davek na prodajo |
digital | Digitalni izdelek |
gift_card | Darilna kartica |
store_credit | Dobropis trgovine |
surcharge | Doplačilo |
Zajem plačil
Zajem po postavki naročila
POST /v1/orders/{id}/transactions/{transaction_id}/captures/orderlines{
"description": "Shipping item #1",
"order_line": {
"merchant_order_line_id": "item-001",
"quantity": 1
}
}Zajem po znesku
POST /v1/orders/{id}/transactions/{transaction_id}/captures/amount{
"description": "Partial capture",
"amount": 2500
}Razveljavitev plačil
Razveljavitev sprosti avtorizirana sredstva nazaj stranki.
Razveljavitev po postavki naročila
POST /v1/orders/{id}/transactions/{transaction_id}/voids/orderlines{
"description": "Voiding item #2",
"order_line": {
"merchant_order_line_id": "item-002",
"quantity": 1
}
}Razveljavitev po znesku
POST /v1/orders/{id}/transactions/{transaction_id}/voids/amount{
"description": "Partial void",
"amount": 1500
}Parametri poizvedbe
Dodajte parametre poizvedbe za vključitev dodatnih podrobnosti v odgovor:
| Parameter | Opis |
|---|---|
?fields[]=order_line_details | Vključi razčlenitev postavk naročila |
?fields[]=amount_details | Vključi razčlenitev zneskov |
Optimistično zaklepanje
Končne točke za zajem in razveljavitev podpirajo optimistično zaklepanje na osnovi ETag prek glave if-match. To preprečuje tekmovalne pogoje, ko več sistemov poskuša zajeti isto transakcijo.
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}'Če se ETag ne ujema (naročilo je bilo spremenjeno od vaše zadnje pridobitve), boste prejeli odgovor 412 Precondition Failed.
Cost+ podpira en zajem na avtorizacijo, razveljavitve pa je mogoče obdelati samo pred kakršnimkoli zajemom. Ustrezno načrtujte svojo strategijo zajema.
Povezane končne točke
- Zajem po znesku — zajemite določen znesek iz avtoriziranega naročila
- Zajem po postavki naročila — zajemite specifične postavke naročila
- Razveljavitev po znesku — razveljavite določen znesek iz avtoriziranega naročila
- Razveljavitev po postavki naročila — razveljavite specifične postavke naročila