Show one payment link with allocations

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

v2Operation ID v2_public_payment_link_show

A payment link records how payments already received on a sales order are split across its invoices (the web app calls this a payment allocation). It is not a URL or payment page your customer opens to pay, and it moves no money.

Returns the link with total (the sum of its allocations) and allocated_transactions: one row per allocation, with the invoice_id, the payment (transaction_id), the allocated total, the payment's unallocated_amount and state existing.

Permission

Any member of the team. No sales order permission is checked.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The payment link's hash id. Hash ids only: a unique key or a document number gives 404.

  • Example IirNDCwiaCVSKx

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (7)

  • allocated_transactionsarray of objectsrequired

    One row per allocation.

    Fields of each item (6)

    • statestring
      • Always "existing"
    • idstring

      The allocation. Send it in allocated_transactions[].id to update or delete it.

    • invoice_idstring

      The invoice it pays.

    • totaldecimal pair

      The allocated amount (usually 3 decimal places; a finer stored amount comes back with a larger dp). A decimal pair: the amount is value ÷ 10^dp ({ "value": 1250, "dp": 2 } is 12.50). Read dp every time: it can differ between fields and records.

      • See Money and quantities.
    • transaction_idstring

      The payment.

    • unallocated_amountdecimal pair

      What the payment still has to allocate (usually 3 decimal places; a finer stored amount comes back with a larger dp). A decimal pair: the amount is value ÷ 10^dp ({ "value": 1250, "dp": 2 } is 12.50). Read dp every time: it can differ between fields and records.

      • See Money and quantities.
  • created_atstring (date-time)required
  • idstringrequired

    The payment link.

  • order_idstringrequired

    The sales order.

  • totaldecimal pairrequired

    The sum of its allocations. A decimal pair: the amount is value ÷ 10^dp ({ "value": 175000, "dp": 4 } is 17.50). Kept at 4 decimal places; { "value": 0, "dp": 0 } when the link has no allocations. Read dp every time.

    • See Money and quantities.
  • updated_atstring (date-time)required
  • notestring | 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.

  When

  The link isn't your team's.

  Fix

  Use an id from List the payment links of a sales order.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  The order came from Shopify and was deleted there (shopify_order_deleted_externally).

  Fix

  Only local cleanup is allowed on that order.

Related

• GETList the payment links of a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_link
• GETGet the starting point for editing a payment link/v2/api/store/{team_slug}/v2/payment_link/{hash_id}/get_update_template
• PUTUpdate a payment link/v2/api/store/{team_slug}/v2/payment_link/{hash_id}

Example request

curl

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

Example response 200

Response

{
  "data": {
    "allocated_transactions": [
      {
        "id": "SAo2jTR8BZUnyc",
        "invoice_id": "gtnwEWU4Npp9eC",
        "state": "existing",
        "total": {
          "dp": 3,
          "value": 12500
        },
        "transaction_id": "tUq7cR8dTLKFPm",
        "unallocated_amount": {
          "dp": 3,
          "value": 2500
        }
      },
      {
        "id": "8Ejv1L5Duc4hRZ",
        "invoice_id": "7ELS3Vmu6QfJxT",
        "state": "existing",
        "total": {
          "dp": 3,
          "value": 5000
        },
        "transaction_id": "tUq7cR8dTLKFPm",
        "unallocated_amount": {
          "dp": 3,
          "value": 2500
        }
      }
    ],
    "created_at": "2026-11-03T15:00:00+00:00",
    "id": "IirNDCwiaCVSKx",
    "note": "Deposit split across two invoices",
    "order_id": "ERwEdCKYNeQIHW",
    "total": {
      "dp": 4,
      "value": 175000
    },
    "updated_at": "2026-11-03T15:05:00+00:00"
  },
  "status": 200,
  "success": true
}