Stöðufyrirspurnir

Hver greiðsla í Cost+ er sýnd sem pöntun sem inniheldur eina eða fleiri færslur. Þú getur athugað núverandi stöðu hvaða pöntunar sem er með fyrirspurn í API, annað hvort með könnun eða með webhook-um.

Sækja stöðu pöntunar

Sendu GET-beiðni á /v1/orders/\{id\}/ til að sækja fullan pöntunarhlutunn þ.á m. núverandi stöðu og allar tengdar færslur.

GET /v1/orders/b9ae6.../

Þótt könnun virki til að athuga stöðu pöntunar eru webhook-ar ráðlagða aðferðin fyrir framleiðslusamþættingar. Þeir veita rauntímatilkynningar án þess að endurteknar API-kallanir séu nauðsynlegar.

Stöður pöntunar

Pöntun þróast í gegnum eftirfarandi stöður:

Staða	Lokastaða	Lýsing
`new`	Nei	Pöntun hefur nýlega verið stofnuð. Engin greiðslutilraun hefur enn verið gerð.
`processing`	Nei	Greiðslutilraun er í gangi. Viðskiptavinurinn gæti verið að ljúka 3D Secure eða öðru staðfestingarskrefi.
`error`	Nei	Greiðslutilraun mistókst. Viðskiptavinurinn getur reynt aftur með sama eða öðrum greiðslumáta.
`completed`	Já	Greiðsla tókst. Þú getur uppfyllt pöntunina.
`cancelled`	Já	Pöntun var hætt, annað hvort af viðskiptavininum eða gegnum API.
`expired`	Já	Pöntun rann út áður en vel heppnuð greiðsla átti sér stað. Sjálfgefið útrunnintímabil er 30 mínútur.

Aðeins stöður merktar sem Lokastaða = Já eru endanlegar. Pantanir í stöðunni new, processing eða error geta enn breyst í completed.

Dæmi: Pöntun í vinnslu

Þegar viðskiptavinur hefur hafið greiðslu en hún er ekki enn lokið:

{
  "id": "b9ae6...",
  "project_id": "proj_abc123",
  "merchant_order_id": "my-order-id-1",
  "created": "2024-01-01T12:00:00.000000+00:00",
  "modified": "2024-01-01T12:01:30.000000+00:00",
  "completed": null,
  "expiration_period": "PT30M",
  "status": "processing",
  "currency": "EUR",
  "amount": 1295,
  "description": "My amazing order",
  "return_url": "https://www.example.com",
  "payment_url": "https://pay.costplus.com/...",
  "webhook_url": "https://www.example.com/webhook",
  "transactions": [
    {
      "id": "txn_001...",
      "payment_method": "credit-card",
      "payment_method_brand": "visa",
      "status": "processing",
      "amount": 1295,
      "currency": "EUR"
    }
  ],
  "flags": ["is-test"]
}

Dæmi: Lokin pöntun

Þegar greiðsla tekst nær pöntunin stöðunni completed:

{
  "id": "b9ae6...",
  "project_id": "proj_abc123",
  "merchant_order_id": "my-order-id-1",
  "created": "2024-01-01T12:00:00.000000+00:00",
  "modified": "2024-01-01T12:02:15.000000+00:00",
  "completed": "2024-01-01T12:02:15.000000+00:00",
  "expiration_period": "PT30M",
  "status": "completed",
  "currency": "EUR",
  "amount": 1295,
  "description": "My amazing order",
  "return_url": "https://www.example.com",
  "payment_url": "https://pay.costplus.com/...",
  "webhook_url": "https://www.example.com/webhook",
  "transactions": [
    {
      "id": "txn_001...",
      "payment_method": "credit-card",
      "payment_method_brand": "visa",
      "payment_method_details": {
        "card_last_four": "4242",
        "card_expiry_month": 12,
        "card_expiry_year": 2026,
        "card_holder_name": "J. Smith"
      },
      "status": "completed",
      "amount": 1295,
      "currency": "EUR"
    }
  ],
  "flags": ["is-test"]
}

Upplýsingar um færslu

Hver færsla innan pöntunar inniheldur eftirfarandi lykilreiti:

Reitur	Lýsing
`payment_method`	Greiðslumátinn sem notaður var (t.d. `credit-card`, `ideal`, `apple-pay`)
`payment_method_brand`	Vörumerkið eða útgefandinn (t.d. `visa`, `mastercard`, `amex`)
`payment_method_details`	Hlutur með máta-sérstökum upplýsingum eins og síðustu fjórum tölustöfum korts, gildistíma og nafni handhafa
`status`	Staða þessarar tilteknu færslu
`amount`	Upphæð færslunnar í sentum
`currency`	Gjaldmiðill færslunnar

Treystið ekki eingöngu á endurbeininguna á return_url þitt sem staðfestingu á greiðslu. Staðfestu alltaf stöðu pöntunar gegnum API eða webhook áður en pöntun er uppfyllt.

Tengdir endapunktar

Sækja pöntun — sæktu fullan pöntunarhlut og núverandi stöðu hans
Listi pantana — listaðu pantanir með síu á dagsetningarbili