List the payment links of a sales order

GET/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_link

v2Operation ID v2_public_sales_order_payment_link_index

A payment link (Allocations in the web app) records which invoices a payment pays: it splits payments received on the order across the order's invoices. It is not a link the customer pays through.

Returns the order's payment links with their totals (total is a decimal pair, usually with dp 4: 50.00 is { "value": 500000, "dp": 4 }). A Shopify order deleted in Shopify answers 422 shopify_order_deleted_externally. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

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
• hash_idstringrequired

  The sales order's or quote's id (a hash id). The ord_ unique key and the order number do not work here.

  • Example V4keXwwxMQyXw7

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired

  The order's payment links, not paginated.

  Fields of each item (6)

  • idstringrequired
  • order_idstringrequired
  • totaldecimal pairrequired

    Total this link allocates. A decimal pair: the amount is value ÷ 10^dp ({ "value": 125000, "dp": 4 } is 12.50). Kept with 4 decimal places; an amount never set can come as { "value": 0, "dp": 0 }. Read dp every time: it can differ between fields and records.

    • See Money and quantities.
  • created_atstring (date-time) | null

    Created. ISO 8601 with offset, or null.

  • notestring | null
  • updated_atstring (date-time) | null

    Last changed. ISO 8601 with offset, or null.

• statusintegerrequired
• successbooleanrequired

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.

Related

• POSTCreate a payment link for a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_link
• GETShow one payment link with allocations/v2/api/store/{team_slug}/v2/payment_link/{hash_id}

Example request

curl

curl 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/V4keXwwxMQyXw7/payment_link' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "created_at": "2026-11-03T09:00:00+00:00",
      "id": "SmIWUp2A3mG3bA",
      "note": null,
      "order_id": "V4keXwwxMQyXw7",
      "total": {
        "dp": 4,
        "value": 500000
      },
      "updated_at": "2026-11-03T09:00:00+00:00"
    }
  ],
  "status": 200,
  "success": true
}