Get what a new payment link can allocate

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

v2Operation ID v2_public_sales_order_payment_link_get_create_template

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 payments that still have money to allocate (unallocated_transactions), to build the body of Create a payment link: each entry has the payment's transaction_id and unallocated_amount (thousandths, dp 3); add action: "create", an invoice_id and the total to allocate. {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.

• dataobjectrequired

  A starting body for Create a payment link.

  Child fields (3)

  • order_idstringrequired
  • unallocated_transactionsarray of objectsrequired

    Payments (recorded, card, and from customer credit) with money not yet allocated; [] when there are none. Add action: "create" and an invoice_id to each entry you send.

    Fields of each item (5)

    • unallocated_amountdecimal pairrequired

      What the payment still has to allocate. A decimal pair: the amount is value ÷ 10^dp ({ "value": 50000, "dp": 3 } is 50.00). Fixed at 3 decimal places (dp 3). Read dp every time: it can differ between fields and records.

      • See Money and quantities.
    • transaction_idstringrequired

      The payment's id.

    • invoice_idnull

      Always null: set it in your Create a payment link entry.

    • statestring

      Always new.

    • totaldecimal pair

      Always 0: put the amount to allocate here. A decimal pair: the amount is value ÷ 10^dp ({ "value": 50000, "dp": 3 } is 50.00). Fixed at 3 decimal places (dp 3). Read dp every time: it can differ between fields and records.

      • See Money and quantities.
  • notenull

    Always 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

Example request

curl

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

Example response 200

Response

{
  "data": {
    "note": null,
    "order_id": "V4keXwwxMQyXw7",
    "unallocated_transactions": [
      {
        "invoice_id": null,
        "state": "new",
        "total": {
          "dp": 3,
          "value": 0
        },
        "transaction_id": "hAwWd7vPrqjuHD",
        "unallocated_amount": {
          "dp": 3,
          "value": 50000
        }
      }
    ]
  },
  "status": 200,
  "success": true
}