Cost+Docs

Iarratais Stádais

Seiceáil stádais orduithe agus idirbheart

Léirítear gach íocaíocht i Cost+ mar ordú a bhfuil idirbheart amháin nó níos mó ann. Is féidir leat stádas reatha aon ordaithe a sheiceáil trí iarratas a dhéanamh ar an API, trí phóláil nó trí bheith ag brath ar webhookeanna.

Stádas Ordaithe a Fháil

Seol iarratas GET chuig /v1/orders/\{id\}/ chun an réad ordaithe iomlán a fháil lena stádas reatha agus gach idirbheart gaolmhar.

GET /v1/orders/b9ae6.../

Cé go n-oibríonn póláil chun stádas ordaithe a sheiceáil, is iad webhookeanna an cur chuige molta le haghaidh comhtháthuithe táirgthe. Cuireann siad fógraí fíor-ama ar fáil gan an forchostas a bhaineann le glaonna API arís is arís eile.

Stádais Ordaithe

Téann ordú trí na stádais seo a leanas:

StádasDeiridhCur Síos
newNílCruthaíodh an t-ordú díreach. Níor rinneadh aon iarracht íocaíochta fós.
processingNílTá iarracht íocaíochta ar siúl. D'fhéadfadh an custaiméir a bheith ag críochnú 3D Secure nó céim fíoraithe eile.
errorTáChuir teip theicniúil deireadh leis an ordú. Cruthaigh ordú nua más rud é gur cheart don chustaiméir triail eile a bhaint as.
completedTáD'éirigh leis an íocaíocht. Is féidir leat an t-ordú a chomhlíonadh.
cancelledTáCuireadh an t-ordú ar ceal, ag an gcustaiméir nó tríd an API.
expiredTáChuaigh an t-ordú in éag sular éirigh le híocaíocht. Is é 30 nóiméad an tréimhse éagtha réamhshocraithe.

Ní stádais deiridh iad ach na stádais atá marcáilte mar Deiridh = Tá. Is féidir le horduithe i stádas new, processing, nó error aistriú go completed fós.

Sampla: Ordú á Phróiseáil

Nuair a thionscain custaiméir íocaíocht ach nach bhfuil sí críochnaithe fós:

{
  "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://api.costplus.online/pay/...",
  "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"]
}

Sampla: Ordú Críochnaithe

Nuair a éiríonn leis an íocaíocht, sroicheann an t-ordú stádas 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://api.costplus.online/pay/...",
  "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"]
}

Sonraí Idirbhirt

Tá na réimsí tábhachtacha seo a leanas i ngach idirbheart laistigh d'ordú:

RéimseCur Síos
payment_methodAn modh íocaíochta a úsáideadh (m.sh., credit-card, ideal, apple-pay)
payment_method_brandAn branda nó an t-eisitheoir (m.sh., visa, mastercard, amex)
payment_method_detailsRéad le sonraí a bhaineann go sonrach leis an modh, amhail na ceithre dhigit deireanacha den chárta, éag, agus ainm an tsealbhóra
statusStádas an idirbhirt shonraigh seo
amountMéid an idirbhirt i mionaonad ISO 4217 an airgeadra
currencyAirgeadra an idirbhirt

Ná bí ag brath ar atreorú an chustaiméara chuig do return_url amháin mar dhearbhú íocaíochta. Fíoraigh stádas an ordaithe i gcónaí tríd an API nó trí webhook sula gcomhlíonann tú ordú.

Críochphointí Gaolmhara

On this page