Skip to content

Get EU Withdrawal

Returns a single withdrawal declaration with its full evidence timeline — the received / confirmation / outcome record for one declaration.

Endpoint

EndpointMethod
/api/admin/eu-withdrawals/{id}GET

Fields

FieldDescription
idDeclaration id.
uuidStable public identifier for the declaration.
orderId / orderIncrementIdThe order the declaration was filed against.
customerId / customerName / customerEmailWho filed the declaration.
isGuesttrue when filed by a guest (no customer account).
channelId / channelCodeThe channel the order was placed in.
localeThe locale the declaration was filed in (used for the confirmation email).
reasonTextThe customer's free-text reason for withdrawing.
statusreceived, declined, or refunded.
receivedAtWhen the declaration was received.
confirmationSentAtWhen the durable-medium confirmation email was sent.
finalConfirmationSentAtWhen a later confirmation was re-sent (if any).
confirmationErrorThe reason the confirmation email failed to send (if any).
declinedAt / declinedReason / declinedByUserId / declinedByNameDecline outcome details (populated only when declined).
refundedAt / refundedByUserId / refundedByName / refundNoteRefund outcome details (populated only when refunded).
createdAt / updatedAtRecord timestamps.

Request

bash
curl -X GET "https://your-domain.com/api/admin/eu-withdrawals/7" \
  -H "Authorization: Bearer <token>" \
  -H "Accept: application/json"

Response

json
{
  "id": 7,
  "uuid": "b2f1c0de-5a2e-4d7a-9f2e-3c1a2b4d5e6f",
  "orderId": 12,
  "orderIncrementId": "000000012",
  "customerId": 5,
  "customerName": "Jane Doe",
  "customerEmail": "[email protected]",
  "isGuest": false,
  "channelId": 1,
  "channelCode": "default",
  "locale": "en",
  "reasonText": "Changed my mind.",
  "status": "refunded",
  "receivedAt": "2026-07-20T09:00:00+00:00",
  "confirmationSentAt": "2026-07-20T09:00:05+00:00",
  "finalConfirmationSentAt": "2026-07-21T14:00:00+00:00",
  "confirmationError": null,
  "declinedAt": null,
  "declinedReason": null,
  "declinedByUserId": null,
  "declinedByName": null,
  "refundedAt": "2026-07-21T14:00:00+00:00",
  "refundedByUserId": 1,
  "refundedByName": "Example Admin",
  "refundNote": "Refunded via original payment method.",
  "message": null,
  "createdAt": "2026-07-20T09:00:00+00:00",
  "updatedAt": "2026-07-21T14:00:00+00:00"
}

Permission

sales.eu_withdrawals

Released under the MIT License.