Statusa pieprasījumi

Katrs maksājums Cost+ sistēmā tiek attēlots kā pasūtījums, kas satur vienu vai vairākus darījumus. Jūs varat pārbaudīt jebkura pasūtījuma pašreizējo statusu, veicot API vaicājumu — vai nu ar aptaujāšanu, vai izmantojot webhook.

Pasūtījuma statusa iegūšana

Nosūtiet GET pieprasījumu uz /v1/orders/\{id\}/, lai iegūtu pilnu pasūtījuma objektu, ieskaitot tā pašreizējo statusu un visus saistītos darījumus.

GET /v1/orders/b9ae6.../

Lai gan aptaujāšana darbojas statusa pārbaudei, webhook ir ieteicamā pieeja produkcijas integrācijām. Tie nodrošina reāllaika paziņojumus bez atkārtotu API izsaukumu papildu slodzes.

Pasūtījumu statusi

Pasūtījums iziet šādus statusus:

Statuss	Galīgs	Apraksts
`new`	Nē	Pasūtījums tikko izveidots. Nav veikts neviens maksājuma mēģinājums.
`processing`	Nē	Maksājuma mēģinājums ir procesā. Klients, iespējams, pabeidz 3D Secure vai citu verifikācijas soli.
`error`	Nē	Maksājuma mēģinājums neizdevās. Klients var mēģināt vēlreiz ar to pašu vai citu maksājumu metodi.
`completed`	Jā	Maksājums bija veiksmīgs. Jūs varat izpildīt pasūtījumu.
`cancelled`	Jā	Pasūtījums tika atcelts — vai nu klients, vai caur API.
`expired`	Jā	Pasūtījuma termiņš beidzās pirms veiksmīga maksājuma. Noklusējuma termiņš ir 30 minūtes.

Tikai statusi ar Galīgs = Jā ir galīgi. Pasūtījumi ar statusu new, processing vai error joprojām var pāriet uz completed.

Piemērs: Pasūtījums apstrādē

Kad klients ir uzsācis maksājumu, bet tas vēl nav pabeigts:

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

Piemērs: Pabeigts pasūtījums

Kad maksājums ir veiksmīgs, pasūtījums sasniedz statusu 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"]
}

Darījuma dati

Katrs darījums pasūtījumā satur šādus galvenos laukus:

Lauks	Apraksts
`payment_method`	Izmantotā maksājumu metode (piemēram, `credit-card`, `ideal`, `apple-pay`)
`payment_method_brand`	Zīmols vai izdevējs (piemēram, `visa`, `mastercard`, `amex`)
`payment_method_details`	Objekts ar metodes specifiskām detaļām, piemēram, kartes pēdējie četri cipari, derīguma termiņš un kartes turētāja vārds
`status`	Šī konkrētā darījuma statuss
`amount`	Darījuma summa centos
`currency`	Darījuma valūta

Nepaļaujieties tikai uz klienta novirzīšanu uz jūsu return_url kā maksājuma apstiprinājumu. Vienmēr verificējiet pasūtījuma statusu caur API vai webhook pirms pasūtījuma izpildes.

Saistītie galapunkti

Iegūt pasūtījumu — iegūt pilnu pasūtījuma objektu un tā pašreizējo statusu
Sarakstīt pasūtījumus — sarakstīt pasūtījumus ar datumu diapazona filtrēšanu