PApawapay
checkouts

Expire checkout

post/v2/checkouts/{checkoutId}/expire

Request

  • Base URL
    https://api.sandbox.pawapay.io
  • URL
    https://api.sandbox.pawapay.io/v2/checkouts/{checkoutId}/expire
  • Auth
    HTTP bearer

Path parameters

checkoutIdstring uuid required

The id of the checkout that you are performing this operation on.

Response

Request has been processed by PawaPay.

checkoutIdstring uuid required

The unique ID for this payment in PawaPay as specified by you during initiation.

status'WAITING_PAYMENT' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'EXPIRED' | 'CANCELLED' required

Possible checkout lifecycle statuses. This is distinct from the initiation status (CheckoutCreationStatus) returned when the checkout is created.

  • WAITING_PAYMENT - The checkout and its hosted payment page have been created and are waiting for the customer to pay.
  • PROCESSING - A payment attempt is in progress and the checkout is still being processed.
  • COMPLETED - The checkout has completed successfully. This is a final status.
  • FAILED - The checkout has failed. Inspect deposit or depositsHistory for the latest attempt result when available. This is a final status.
  • EXPIRED - The checkout has expired and can no longer be used. This is a final status.
  • CANCELLED - The customer cancelled the payment on the hosted payment page. This is a final status.
expiredAtstring date-time

Timestamp when the checkout was expired.

reasonstring

Reason reported for the expiration.

expiredBystring

Actor that expired the checkout.

Example response

{
  "checkoutId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
  "expiredAt": "2026-03-27T10:45:00Z",
  "reason": "MANUAL_EXPIRY",
  "expiredBy": "API"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.