Talbiet tal-Istatus
Iċċekkja l-istatus tal-ordnijiet u t-tranżazzjonijiet
Kull ħlas f'Cost+ huwa rappreżentat minn ordni li fih tranżazzjoni waħda jew aktar. Tista' tiċċekkja l-istatus kurrenti ta' kwalunkwe ordni billi tistaqsi l-API, jew billi tagħmel polling jew billi tiddependi fuq webhooks.
Iġbed l-Istatus tal-Ordni
Ibgħat talba GET lejn /v1/orders/\{id\}/ biex tiġbed l-oġġett sħiħ tal-ordni inkluż l-istatus kurrenti tagħha u t-tranżazzjonijiet kollha assoċjati.
GET /v1/orders/b9ae6.../Filwaqt li l-polling jaħdem biex tiċċekkja l-istatus tal-ordni, il-webhooks huma l-approċċ rakkomandat għal integrazzjonijiet tal-produzzjoni. Jipprovdu notifiki f'ħin reali mingħajr il-piż ta' sejħiet ripetuti tal-API.
Statuses tal-Ordni
Ordni tavvanza minn dawn l-istatus:
| Status | Finali | Deskrizzjoni |
|---|---|---|
new | Le | L-ordni għadha kemm inħolqot. L-ebda tentattiv ta' ħlas għadu ma sar. |
processing | Le | Tentattiv ta' ħlas qed isir. Il-klijent jista' jkun qed jlesti 3D Secure jew pass ta' verifika ieħor. |
error | Iva | Falliment tekniku temm l-ordni. Oħloq ordni ġdida jekk il-klijent għandu jerġa' jipprova. |
completed | Iva | Il-ħlas irnexxielu. Tista' tissodisfa l-ordni. |
cancelled | Iva | L-ordni ġiet ikkanċellata, jew mill-klijent jew permezz tal-API. |
expired | Iva | L-ordni skadiet qabel ma sar ħlas b'suċċess. Il-perjodu ta' skadenza default huwa 30 minuta. |
L-istatus biss immarkati bħala Finali = Iva huma terminali. Ordnijiet bl-istatus new, processing, jew error xorta jistgħu jgħaddu għal completed.
Eżempju: Ordni fi Processing
Meta klijent beda ħlas iżda għadu ma lestiex:
{
"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"]
}Eżempju: Ordni Kompluta
Ladarba l-ħlas jirnexxielu, l-ordni tilħaq l-istatus 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"]
}Dettalji tat-Tranżazzjoni
Kull tranżazzjoni fi ħdan ordni fiha l-oqsma ewlenin li ġejjin:
| Qasam | Deskrizzjoni |
|---|---|
payment_method | Il-metodu ta' ħlas użata (eż., credit-card, ideal, apple-pay) |
payment_method_brand | Il-marka jew l-emittent (eż., visa, mastercard, amex) |
payment_method_details | Oġġett b'dettalji speċifiċi għall-metodu bħall-aħħar erba' ċifri tal-karta, skadenza, u isem id-detentur |
status | L-istatus ta' din it-tranżazzjoni speċifika |
amount | L-ammont tat-tranżazzjoni fl-unità minuri ISO 4217 tal-munita |
currency | Il-munita tat-tranżazzjoni |
Tiddependix biss fuq li l-klijent jiġi ridirezzjonat lejn ir-return_url tiegħek bħala konferma tal-ħlas. Dejjem ivverifika l-istatus tal-ordni permezz tal-API jew permezz ta' webhook qabel ma tissodisfa ordni.
Endpoints Relatati
- Ikseb Ordni — iġbed l-oġġett sħiħ tal-ordni u l-istatus kurrenti tagħha
- Lista ta' Ordnijiet — lista ta' ordnijiet bi filtru ta' firxa ta' dati