Cost+Docs

Údaruithe, Gabhálacha & Neamhnithe

Bainistigh sreafaí údaraithe, gabhála agus neamhnithe íocaíochta

Tacaíonn roinnt modhanna íocaíochta le sreabhadh dhá chéim: údaraigh ar dtús (cuir cistí in áirithe), ansin gabh (bailithe cistí) nó neamhnigh (scaoil an áirithint).

Modhanna Gabhála

Socraigh capture_mode ar an ordú chun smacht a fháil ar cathain a ghabhtar cistí:

MódIompraíocht
manualGabhann tú go sainráite nuair atá tú réidh (m.sh., tar éis seolta). Mura ngabhann tú sula n-éagann an t-ordú, caillfear an t-údarú agus ní féidir é a ghabháil.
delayedGabhtar cistí go huathoibríoch nuair a éagann an expiration_period.
POST /v1/orders/ (manual capture)
{
  "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"
    }
  ]
}

Le gabháil manual, ní mór duit gabháil sula gcríochnaíonn tréimhse éaga an ordaithe. Nuair a éagann sé, scaoiltear an t-údarú agus ní féidir na cistí a ghabháil. Socraigh expiration_period oiriúnach do d'amlíne comhlíonta.

Is féidir leat capture_mode a shocrú ag leibhéal an ordaithe gan transactions a shonrú. Ní thaispeánfaidh an leathanach íocaíochta óstáilte ach modhanna íocaíochta a thacaíonn leis an mód gabhála sonraithe.

Méideanna Ingabhála a Sheiceáil

Sula ngabhann tú, is féidir leat seiceáil cé mhéid atá ar fáil le gabháil trí amount_details a iarraidh:

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

Áirítear réad amount_details san fhreagra:

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

Línte Ordaithe

Agus gabhálacha agus neamhnithe á n-úsáid de réir líne ordaithe, úsáid na cineálacha seo:

CineálCur Síos
physicalTáirge fisiciúil
discountMéid lascaine
shipping_feeCostas seolta
sales_taxCáin díolacháin
digitalTáirge digiteach
gift_cardCárta bronntanais
store_creditCreidmheas siopa
surchargeFormhuirear

Íocaíochtaí a Ghabháil

Gabháil de réir Líne Ordaithe

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

Gabháil de réir Méid

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

Íocaíochtaí a Neamhniú

Scaoileann neamhniú na cistí údaraithe ar ais chuig an gcustaiméir.

Neamhniú de réir Líne Ordaithe

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

Neamhniú de réir Méid

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

Paraiméadair Iarratais

Cuir paraiméadair iarratais leis chun sonraí breise a chur san fhreagra:

ParaiméadarCur Síos
?fields[]=order_line_detailsCuir miondealú línte ordaithe san áireamh
?fields[]=amount_detailsCuir miondealú méideanna san áireamh

Glasáil Dhóchasach

Tacaíonn críochphointí gabhála agus neamhnithe le glasáil dhóchasach bunaithe ar ETag tríd an gceanntásc if-match. Cuireann sé seo cosc ar choinníollacha rása nuair a dhéanann córais iolracha iarracht an t-idirbheart céanna a ghabháil.

Capture with optimistic locking
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}'

Mura meaitseálann an ETag (athraíodh an t-ordú ó rinne tú é a fháil go deireanach), gheobhaidh tú freagra 412 Precondition Failed.

Tacaíonn Cost+ le gabháil amháin in aghaidh an údaraithe, agus ní féidir neamhnithe a phróiseáil ach roimh aon ghabháil. Pleanáil do straitéis gabhála dá réir.

Críochphointí Gaolmhara

On this page