Skip to content

Check a pending card payment (v1, not usable)

Open .md

POST/v1/api/store/{team_slug}/sales_order/poll_pending_payment

v1Legacy · deprecatedOperation ID v1_public_sales_order_payment_gateway_polling

Meant to check a pending card payment. Card-payment polling isn't usable through the public API: every call fails with HTTP 500 ({"message": "Server Error"}), here and on the v2 path, because the route has no place for the pending payment's id. YoPrint checks pending payments in the background; read the order's payments with List the payments of a sales order instead.

Permission

Any member of the team.

Path parameters

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team

Request body

application/json, required.

  • poll_tokenstringrequired

    The poll_token from Charge a card.

Response

200Never sent: this route always fails with HTTP 500.

No response body.

Errors

  • 401The API key is missing or wrong (unauthenticated).

  • 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  • 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  • 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

    When
    Always, as described above.
    Fix
    List the order's payments instead.