Weav Docsv1
Back to homeSupportGet API keys

API reference / Checkouts

List checkouts

View as Markdown
More actions
Open in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this pageOpen in GrokAsk questions about this pageConnect to CursorInstall the MCP server in CursorConnect to VS CodeInstall the MCP server in VS Code
GET/v1/checkouts

Your checkouts in this mode, newest first, with cursor pagination.

Query parameters

  • per_pageinteger
    Items per page, 25 by default; values above 100 become 100.
    At least 1Default: 25
  • cursorstring
    The next_cursor or prev_cursor from the previous page.
    Up to 1024 characters
  • date_fromstring (date)
    Start date (Asia/Manila), inclusive. Send with date_to.
  • date_tostring (date)
    End date (Asia/Manila), inclusive.
  • statusstring
    Only checkouts with this status. OPEN, COMPLETED, EXPIRED or CANCELLED.
    One of: OPEN COMPLETED EXPIRED CANCELLED
  • external_reference_idstring
    Up to 64 characters

Headers

  • AuthorizationstringRequired
    Bearer plus your API key. See Authentication.

Responses

200 OK

Your checkouts in this mode, newest first.

What data holds
  • checkoutsarray of objects
    23 fields in checkouts
    • reference_idstring
    • external_reference_idstring | null
    • typestring
      One of: ORDER AMOUNT
    • statusstring
      One of: OPEN COMPLETED EXPIRED CANCELLED
    • currencystring
      ISO 4217. PHP today; more as they're enabled for your account.
      One of: PHP
    • amountnumber
      The total, in pesos.
    • descriptionstring | null
    • itemsarray of objects
      4 fields in items
      • namestringRequired
        Up to 255 characters
      • quantityintegerRequired
        At least 1At most 9999
      • unit_amountnumberRequired
        Pesos, as a JSON number.
      • amountnumber
        quantity × unit_amount.
    • channelsarray of strings | null
      One of: QR_PH GCASH MAYA CARD PAY_AND_GO PALAWANPAY BAYAD
    • qr_ph_appsarray of strings | null
    • customerobject
      4 fields in customer
      • idstring | null
        Your ID for the customer, with save_payment_method.
      • namestring | null
      • emailstring | null
      • mobile_nostring | null
    • save_payment_methodboolean
      A card payment also saves the card (the payment's payment_method_id).
    • checkout_urlstring (uri)
    • success_urlstring | null
    • cancel_urlstring | null
    • webhook_urlstring | null
    • paymentany
      The payment that paid it.
    • expires_atstring (date-time)
    • completed_atstring (date-time) | null
    • expired_atstring (date-time) | null
    • cancelled_atstring (date-time) | null
    • created_atstring (date-time)
    • updated_atstring (date-time)
  • paginationobject
    4 fields in pagination
    • per_pageintegerRequired
    • next_cursorstring | nullRequired
    • prev_cursorstring | nullRequired
    • is_last_pagebooleanRequired

401 Unauthorized

Missing, malformed or unknown API key (code 4010000).

403 Forbidden

The key can't make this request (code 4030000): an address outside the key's IP allowlist, a live key before your live mode is on, or an account that isn't active. A live key sent from a browser is refused (code 4030001): keep live keys on your server.

GET

Try it: List checkouts

Test mode
Authorization
Query Optional
cURL
Uses $WEAV_API_KEY, never your key. Paste it into a terminal, or import it into Postman.
Response
Send the request to see Weav's answer here.
curl -X GET https://api.weavpayments.com/v1/checkouts \
    -H "Authorization: Bearer $WEAV_API_KEY"
{
    "code": "2000000",
    "success": true,
    "message": "OK",
    "data": {
        "checkouts": [
            {
                "reference_id": "CK4T8M2Q7X9KBA",
                "external_reference_id": "ORD-10541",
                "type": "ORDER",
                "status": "COMPLETED",
                "currency": "PHP",
                "amount": 1250.0,
                "description": null,
                "items": [
                    {
                        "name": "Canvas tote bag",
                        "quantity": 1,
                        "unit_amount": 1000.0,
                        "amount": 1000.0
                    },
                    {
                        "name": "Canvas Strap",
                        "quantity": 2,
                        "unit_amount": 125.0,
                        "amount": 250.0
                    }
                ],
                "channels": null,
                "qr_ph_apps": null,
                "customer": {
                    "id": null,
                    "name": null,
                    "email": null,
                    "mobile_no": null
                },
                "save_payment_method": false,
                "checkout_url": "https://pay.weavpayments.com/checkout/CK4T8M2Q7X9KBA",
                "success_url": "https://shop.example.com/orders/ORD-10541/thanks",
                "cancel_url": "https://shop.example.com/cart",
                "webhook_url": null,
                "payment": {
                    "reference_id": "PY7K3Q9M2X4TBA",
                    "checkout_reference_id": "CK4T8M2Q7X9KBA",
                    "status": "COMPLETED",
                    "…": "…"
                },
                "expires_at": "2026-10-27T10:12:00+08:00",
                "completed_at": "2026-10-26T10:15:40+08:00",
                "expired_at": null,
                "cancelled_at": null,
                "created_at": "2026-10-26T10:12:00+08:00",
                "updated_at": "2026-10-26T10:15:41+08:00"
            }
        ],
        "pagination": {
            "per_page": 25,
            "next_cursor": "eyJpZCI6MTM0LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
            "prev_cursor": null,
            "is_last_page": false
        }
    }
}