# Get the starting point for editing a payment link

```http
GET https://secure.yoprint.com/v2/api/store/{team_slug}/v2/payment_link/{hash_id}/get_update_template
```

- API version: v2
- Operation ID: `v2_public_payment_link_get_update_template`
- Section: Invoices and payments › [Payment links](https://developer.yoprint.com/reference/payment-links.md)
- Web page: https://developer.yoprint.com/reference/payment-links/v2-payment-link-get-update-template/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Returns what you need to build an Update a payment link body: the link with its `allocated_transactions` (`state` `existing`, each with its allocation `id`), plus `unallocated_transactions`: every payment on the order that still has money to allocate (`state` `new`, `transaction_id`, `unallocated_amount`, `invoice_id` null and a zero `total`).

To edit: change `total` on existing rows and mark them `update` or `delete`; fill `invoice_id` and `total` on new rows and mark them `create`. Amounts in allocations must use exactly 3 decimal places (`dp: 3`):
- Correct: `{ "value": 12500, "dp": 3 }` for 12.50.
- Wrong: `{ "value": 1250, "dp": 2 }` — the server always interprets `value` as thousandths (scale 3), which would mean 1.250, and validation requires `dp: 3`.

In answers, the link's own `total` uses 4 decimal places (`{ "value": 175000, "dp": 4 }` is 17.50): always read each pair's `dp`.

## Permission

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

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): 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.

### Example request

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

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `allocated_transactions` (array of objects, required): One row per allocation.
    - Each item:
      - `state` (string, optional): Always `"existing"`.
      - `id` (string, optional): The allocation. Send it in `allocated_transactions[].id` to update or delete it.
      - `invoice_id` (string, optional): The invoice it pays.
      - `total` (decimal pair, optional): 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 https://developer.yoprint.com/concepts/money-and-quantities.md.
      - `transaction_id` (string, optional): The payment.
      - `unallocated_amount` (decimal pair, optional): 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 https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `created_at` (string (date-time), required)
  - `id` (string, required): The payment link.
  - `order_id` (string, required): The sales order.
  - `total` (decimal pair, required): 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 https://developer.yoprint.com/concepts/money-and-quantities.md.
  - `updated_at` (string (date-time), required)
  - `note` (string | null, optional)
  - `unallocated_transactions` (array of objects, optional): Payments on the order that still have money to allocate.
    - Each item:
      - `state` (string, optional): Always `"new"`.
      - `invoice_id` (null, optional): Fill in the invoice to allocate to.
      - `total` (decimal pair, optional): Starts at `{ "value": 0, "dp": 3 }`: fill in the amount. 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 https://developer.yoprint.com/concepts/money-and-quantities.md.
      - `transaction_id` (string, optional): A payment with money left to allocate.
      - `unallocated_amount` (decimal pair, optional): What it has left (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 https://developer.yoprint.com/concepts/money-and-quantities.md.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "allocated_transactions": [
      {
        "id": "SAo2jTR8BZUnyc",
        "invoice_id": "gtnwEWU4Npp9eC",
        "state": "existing",
        "total": {
          "dp": 3,
          "value": 15000
        },
        "transaction_id": "tUq7cR8dTLKFPm",
        "unallocated_amount": {
          "dp": 3,
          "value": 5000
        }
      }
    ],
    "created_at": "2026-11-03T15:00:00+00:00",
    "id": "IirNDCwiaCVSKx",
    "note": "Deposit split across two invoices",
    "order_id": "ERwEdCKYNeQIHW",
    "total": {
      "dp": 4,
      "value": 150000
    },
    "unallocated_transactions": [
      {
        "invoice_id": null,
        "state": "new",
        "total": {
          "dp": 3,
          "value": 0
        },
        "transaction_id": "tUq7cR8dTLKFPm",
        "unallocated_amount": {
          "dp": 3,
          "value": 5000
        }
      }
    ],
    "updated_at": "2026-11-03T15:00:00+00:00"
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You 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`.
- `404` Not 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: Check the id.
- `422` The 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

- [Update a payment link](https://developer.yoprint.com/reference/payment-links/v2-payment-link-update.md): `PUT /v2/api/store/{team_slug}/v2/payment_link/{hash_id}`
- [Show one payment link with allocations](https://developer.yoprint.com/reference/payment-links/v2-payment-link-show.md): `GET /v2/api/store/{team_slug}/v2/payment_link/{hash_id}`