Modifier le statut du paiement

Modifiez le statut du paiement enregistré, par exemple après confirmation d’un virement. Envoyez le nouveau statut, la version actuelle du paiement et le motif du changement.

PATCH/api/v1/orders/{order_id}/payment-status

Requête cURL

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request PATCH \
  --url https://shop.onshopently.com/api/v1/orders/order-0000/payment-status \
  --header 'Authorization: Bearer EXAMPLE_ACCESS_TOKEN' \
  --header 'Idempotency-Key: example-adjust_payment_status_api_v1_orders__order_id__payment_status_patch' \
  --header 'Content-Type: application/json' \
  --data-raw '{"expected_version":0,"reason":"Bank transfer confirmed","status":"paid"}'

Réponse

{
  "data": {
    "deleted": false,
    "id": "payment-0000",
    "version": 2
  },
  "meta": {
    "request_id": "example"
  }
}

Autorisations requises

Authentification: Jeton d’accès
Disponible à partir de: BASIC
Autorisation de la clé: Ajuster le statut du paiementpayments.payment:adjust_status