DocsHeimildir, söfnun og ógilding
Stjórnaðu flæði heimildar, söfnunar og ógildingar greiðslna
Sumir greiðslumátar styðja tveggja skrefa flæði: fyrst heimilaðu (pöntuðu fjármuni), síðan safnaðu (innheimtu fjármunina) eða ógiltu (losaðu pantanir).
Söfnunarhamur
Stilltu capture_mode á pöntunina til að stjórna hvenær fjármunir eru innheimtir:
| Hamur | Hegðun |
|---|---|
manual | Þú safnar sérstaklega þegar þú ert tilbúin/n (t.d. eftir sendingu). Ef þú safnar ekki áður en pöntunin rennur út, tapast heimildin og er ekki hægt að safna. |
delayed | Fjármunir eru sjálfkrafa innheimtir þegar expiration_period rennur út. |
{
"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"
}
]
}Með manual söfnun verður þú að safna áður en gildistími pöntunar rennur út. Þegar það gerist er heimildin losuð og fjármunir ekki tiltækir til söfnunar. Stilltu viðeigandi expiration_period fyrir tímalínu uppfyllingar þinnar.
Þú getur stillt capture_mode á pöntunarstigi án þess að tilgreina transactions. Hýsta greiðslusíðan mun þá aðeins sýna greiðslumáta sem styðja tilgreindan söfnunarham.
Athugun á upphæðum til söfnunar
Áður en þú safnar geturðu athugað hversu mikið er tiltækt til söfnunar með amount_details beiðni:
curl -u YOUR_API_KEY: \
"https://api.costplus.online/v1/orders/{order_id}/?fields[]=amount_details"Svarið inniheldur amount_details hlut:
{
"amount": 5000,
"amount_details": {
"capturable": 5000,
"captured": 0,
"refundable": 0,
"refunded": 0,
"voidable": 5000,
"voided": 0
}
}Pöntunarlínur
Þegar söfnun og ógilding er eftir pöntunarlínu, notaðu þessar tegundir:
| Tegund | Lýsing |
|---|---|
physical | Efnisleg vara |
discount | Afsláttarupphæð |
shipping_fee | Sendingarkostnaður |
sales_tax | Söluskattur |
digital | Stafræn vara |
gift_card | Gjafakort |
store_credit | Innistæða verslunar |
surcharge | Aukagjald |
Söfnun greiðslna
Söfnun eftir pöntunarlínu
POST /v1/orders/{id}/transactions/{transaction_id}/captures/orderlines{
"description": "Shipping item #1",
"order_line": {
"merchant_order_line_id": "item-001",
"quantity": 1
}
}Söfnun eftir upphæð
POST /v1/orders/{id}/transactions/{transaction_id}/captures/amount{
"description": "Partial capture",
"amount": 2500
}Ógilding greiðslna
Ógilding losar heimilaða fjármuni aftur til viðskiptavinar.
Ógilding eftir pöntunarlínu
POST /v1/orders/{id}/transactions/{transaction_id}/voids/orderlines{
"description": "Voiding item #2",
"order_line": {
"merchant_order_line_id": "item-002",
"quantity": 1
}
}Ógilding eftir upphæð
POST /v1/orders/{id}/transactions/{transaction_id}/voids/amount{
"description": "Partial void",
"amount": 1500
}Fyrirspurnarbreytur
Bættu fyrirspurnarbreytum við til að fela viðbótarupplýsingar í svarinu:
| Breyta | Lýsing |
|---|---|
?fields[]=order_line_details | Innifela sundurliðun pöntunarlínu |
?fields[]=amount_details | Innifela sundurliðun upphæða |
Bjartsýnislæsing
Söfnunar- og ógildingarendapunktar styðja ETag-byggða bjartsýnislæsingu gegnum if-match haus. Þetta kemur í veg fyrir keppnisástand þegar mörg kerfi reyna að safna sömu færslu.
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}'Ef ETag passar ekki (pöntunin hefur breyst síðan þú sóttir hana síðast) færðu 412 Precondition Failed svar.
Cost+ styður eina söfnun á hverja heimild og aðeins er hægt að vinna úr ógildingum áður en söfnun á sér stað. Skipuleggðu söfnunaráætlun þína í samræmi við það.
Tengdir endapunktar
- Söfnun eftir upphæð — safnaðu tiltekinni upphæð úr heimilaðri pöntun
- Söfnun eftir pöntunarlínu — safnaðu tilteknum pöntunarlínum
- Ógilding eftir upphæð — ógiltu tiltekna upphæð úr heimilaðri pöntun
- Ógilding eftir pöntunarlínu — ógiltu tilteknar pöntunarlínur