Cost+Docs

Atmaksas

Apstrādājiet pilnas un daļējas atmaksas

Cost+ atbalsta gan pilnas, gan daļējas atmaksas pabeigtiem pasūtījumiem. Atmaksas tiek apstrādātas, izmantojot sākotnējo maksājumu metodi, ar kuru tika veikts darījums.

Atmaksas izveide

Nosūtiet POST pieprasījumu uz /v1/orders/\{id\}/refunds/, lai uzsāktu atmaksu pabeigtam pasūtījumam.

Pieprasījums

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

amount lauks ir centos. Lai atmaksātu 1,00 EUR, iestatiet amount uz 100. Lai veiktu pilnu atmaksu, iestatiet summu uz pilnu pasūtījuma summu.

Pieprasījuma lauki

LauksObligātsApraksts
amountAtmaksas summa centos
descriptionAtmaksas iemesls
merchant_order_idJūsu pašu atsauces ID atmaksai
extraPapildu metadati kā atslēgas-vērtības objekts

Atbilde

API atgriež atmaksas objektu ar tā pašreizējo statusu:

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

Atbildes lauki

LauksApraksts
idUnikāls atmaksas identifikators
createdLaika zīmogs, kad atmaksa tika izveidota
modifiedLaika zīmogs, kad atmaksa tika pēdējo reizi atjaunināta
amountAtmaksas summa centos
currencyAtmaksas valūta (atbilst pasūtījuma valūtai)
statusPašreizējais atmaksas statuss (pending, completed, failed)
descriptionAtmaksas iemesls
merchant_order_idJūsu atsauces ID
extraPapildu metadati

Pilna vs daļēja atmaksa

  • Pilna atmaksa: Iestatiet amount uz kopējo pasūtījuma summu. Viss maksājums tiek atgriezts klientam.
  • Daļēja atmaksa: Iestatiet amount uz mazāku summu nekā kopējā pasūtījuma summa. Tiek atgriezta tikai norādītā summa.

Varat veikt vairākas daļējas atmaksas vienam pasūtījumam, kamēr kopējā atmaksātā summa nepārsniedz sākotnējo pasūtījuma summu.

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

Atmaksas var veikt tikai pasūtījumiem ar statusu completed. Mēģinājums atmaksāt pasūtījumu, kas vēl nav pabeigts, radīs kļūdu.

Izmantojiet merchant_order_id lauku, lai saistītu atmaksas ar jūsu iekšējām sistēmām. Tas ir īpaši noderīgi, veicot vairākas daļējas atmaksas vienam pasūtījumam.

Atmaksu statusi

StatussApraksts
pendingAtmaksa ir uzsākta un tiek apstrādāta.
completedAtmaksa ir veiksmīgi apstrādāta. Līdzekļi tiks atgriezti klientam.
failedAtmaksu nevarēja apstrādāt. Sazinieties ar Cost+ atbalstu.

Laiks, kas nepieciešams, lai atmaksātā summa parādītos klienta kontā, ir atkarīgs no maksājumu metodes un klienta bankas. Kredītkaršu atmaksas parasti aizņem 5-10 darba dienas.

Atmaksājamās summas pārbaude

Pirms daļējas atmaksas veikšanas varat pārbaudīt, cik ir pieejams:

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

Lauks refundable atbildē parāda maksimālo summu, ko varat atmaksāt.

Saistītie galapunkti

On this page