Olekupäringud

Iga makse Cost+-is on esindatud tellimusena, mis sisaldab ühte või mitut tehingut. Saate kontrollida mis tahes tellimuse praegust olekut API päringuga, kas küsitlemise teel või tuginedes veebihaakidele.

Tellimuse oleku pärimine

Saatke GET päring aadressile /v1/orders/\{id\}/, et pärida täielik tellimusobjekt koos selle praeguse oleku ja kõigi seotud tehingutega.

GET /v1/orders/b9ae6.../

Kuigi küsitlemine töötab tellimuse oleku kontrollimiseks, on tootmisintegratsioonide jaoks soovitatav lähenemine veebihaagid. Need pakuvad reaalajas teavitusi ilma korduvate API kutsete lisakuluta.

Tellimuse olekud

Tellimus läbib järgmised olekud:

Olek	Lõplik	Kirjeldus
`new`	Ei	Tellimus on äsja loodud. Maksekatset pole veel tehtud.
`processing`	Ei	Maksekatse on pooleli. Klient võib lõpetada 3D Secure'i või muu kontrollimise sammu.
`error`	Ei	Maksekatse ebaõnnestus. Klient saab uuesti proovida sama või teise makseviisiga.
`completed`	Jah	Makse oli edukas. Saate tellimuse täita.
`cancelled`	Jah	Tellimus tühistati kliendi või API kaudu.
`expired`	Jah	Tellimus aegus enne eduka makse teostamist. Vaikimisi aegumisperiood on 30 minutit.

Ainult olekud, mis on märgitud kui Lõplik = Jah, on lõppseisundid. Tellimused olekutes new, processing või error võivad siiski liikuda olekusse completed.

Näide: Tellimus töötlemisel

Kui klient on algatanud makse, kuid see ei ole veel lõpetatud:

{
  "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"]
}

Näide: Lõpetatud tellimus

Kui makse on edukas, jõuab tellimus olekusse 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"]
}

Tehingu üksikasjad

Iga tehing tellimuse sees sisaldab järgmisi põhivälju:

Väli	Kirjeldus
`payment_method`	Kasutatud makseviis (nt `credit-card`, `ideal`, `apple-pay`)
`payment_method_brand`	Bränd või väljastaja (nt `visa`, `mastercard`, `amex`)
`payment_method_details`	Objekt meetodispetsiifiliste üksikasjadega, nagu kaardi viimased neli numbrit, kehtivusaeg ja kaardivaldaja nimi
`status`	Selle konkreetse tehingu olek
`amount`	Tehingu summa sentides
`currency`	Tehingu valuuta

Ärge tuginege makse kinnitamisel ainult kliendi ümbersuunamisele teie return_url-ile. Kontrollige alati tellimuse olekut API või veebihaagi kaudu enne tellimuse täitmist.

Seotud lõpp-punktid

Tellimuse pärimine — pärige täielik tellimusobjekt ja selle praegune olek
Tellimuste loetelu — loetlege tellimused kuupäevavahemiku filtreerimisega