Cost+Docs

Rifużjonijiet

Ipproċessa rifużjonijiet sħaħ u parzjali

Cost+ tappoġġja kemm rifużjonijiet sħaħ u parzjali fuq ordnijiet kompluti. Ir-rifużjonijiet jiġu pproċessati permezz tal-metodu ta' ħlas oriġinali użata għat-tranżazzjoni.

Ħolqien ta' Rifużjoni

Ibgħat talba POST lejn /v1/orders/\{id\}/refunds/ biex tibda rifużjoni fuq ordni kompluta.

Talba

{
  "amount": 100,
  "description": "Refund for item",
  "merchant_order_id": "refund-001"
}

Il-qasam amount juża l-unità minuri ISO 4217 tal-munita. Għal EUR, ir-rimborż ta' 1.00 EUR ifisser l-issettjar ta' amount għal 100. Biex toħroġ rifużjoni sħiħa, uża l-ammont sħiħ tal-ordni.

Oqsma tat-Talba

QasamMeħtieġDeskrizzjoni
amountIvaAmmont tar-rifużjoni fl-unità minuri ISO 4217 tal-munita
descriptionLeRaġuni għar-rifużjoni
merchant_order_idLeL-ID ta' referenza tiegħek għar-rifużjoni
extraLeMetadata addizzjonali bħala oġġett key-value

Risposta

L-API tirritorna l-oġġett tar-rifużjoni bl-istatus kurrenti tagħha:

{
  "id": "ref_abc123...",
  "created": "2024-01-02T10:00:00.000000+00:00",
  "modified": "2024-01-02T10:00:00.000000+00:00",
  "amount": 100,
  "currency": "EUR",
  "status": "pending",
  "description": "Refund for item",
  "merchant_order_id": "refund-001",
  "extra": null
}

Oqsma tar-Risposta

QasamDeskrizzjoni
idIdentifikatur uniku għar-rifużjoni
createdTimestamp meta nħolqot ir-rifużjoni
modifiedTimestamp meta ġiet aġġornata l-aħħar ir-rifużjoni
amountAmmont tar-rifużjoni fl-unità minuri ISO 4217 tal-munita
currencyMunita tar-rifużjoni (taqbel mal-munita tal-ordni)
statusIstatus kurrenti tar-rifużjoni (pending, completed, failed)
descriptionRaġuni għar-rifużjoni
merchant_order_idL-ID ta' referenza tiegħek
extraMetadata addizzjonali

Rifużjonijiet Sħaħ vs. Parzjali

  • Rifużjoni sħiħa: Issettja l-amount għall-ammont totali tal-ordni. Il-ħlas kollu jiġi rritornat lill-klijent.
  • Rifużjoni parzjali: Issettja l-amount għal inqas mill-ammont totali tal-ordni. L-ammont speċifikat biss jiġi rritornat.

Tista' toħroġ rifużjonijiet parzjali multipli fuq l-istess ordni, sakemm l-ammont totali rrrifondut ma jaqbiżx l-ammont oriġinali tal-ordni.

{
  "amount": 500,
  "description": "Partial refund - damaged item"
}

Ir-rifużjonijiet jistgħu jinħarġu biss fuq ordnijiet bl-istatus completed. Li tipprova tirrifondi ordni li għadha ma tlestiex se jirriżulta fi żball.

Uża l-qasam merchant_order_id biex torbot ir-rifużjonijiet lura mas-sistemi interni tiegħek. Dan huwa speċjalment utli meta toħroġ rifużjonijiet parzjali multipli fuq l-istess ordni.

Statuses tar-Rifużjoni

StatusDeskrizzjoni
pendingIr-rifużjoni ġiet inizjata u qed tiġi pproċessata.
completedIr-rifużjoni ġiet ipproċessata b'suċċess. Il-fondi jiġu rritornati lill-klijent.
failedIr-rifużjoni ma setgħetx tiġi pproċessata. Ikkuntattja l-appoġġ ta' Cost+ għal assistenza.

Il-ħin li jieħu biex l-ammont irrifondat jidher fil-kont tal-klijent jiddependi mill-metodu ta' ħlas u l-bank tal-klijent. Ir-rifużjonijiet tal-karti ta' kreditu tipikament jieħdu 5-10 ijiem ta' negozju.

Iċċekkja l-Ammont li Jista' Jiġi Rrrifondat

Qabel ma toħroġ rifużjoni parzjali, tista' tiċċekkja kemm hemm disponibbli:

curl -u YOUR_API_KEY: \
  "https://api.costplus.online/v1/orders/{order_id}/?fields[]=amount_details"

Il-qasam refundable fir-risposta juri l-ammont massimu li tista' tirrifondi.

Endpoints Relatati

On this page