payware_products_create_placement
Creates a product placement with carriers like QR, NFC, or link, returning a placementId that attributes payments to that medium.
Instructions
[Merchant] Create a placement for a product; a product has no limit on its placements. The response carries its placementId, which goes on the medium wherever the product ID would: a QR code (its payware link, or payware:{placementId}), an NFC tag, a BLE beacon, a link, a barcode or an SMS. A bank resolving it pays for the product, and the payment is attributed to the placement. For a SOUNDBITE carrier, add airing rules so taps during the airing are attributed.
Endpoint: POST /products/{productId}/placements (PRM plan)
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"productId": "<productId>",
"name": "<name>",
"medium": "<medium>",
"carriers": "<carriers>"
},
"name": "payware_products_create_placement"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Placement name, up to 100 characters, e.g. "Sofia metro posters, October" | |
| active | No | Whether it is in use. Governs airing and soundbite attribution; a printed code keeps resolving until the placement is deleted | |
| medium | Yes | What the placement is | |
| channel | No | Descriptive, e.g. the TV channel or the website, up to 100 characters | |
| regions | No | ISO 3166-1 alpha-2 codes of the countries it airs in, matched against the paying bank's country. Empty means anywhere | |
| activeTo | No | End of its active window, ISO-8601 with an offset. Empty means the product's | |
| carriers | Yes | The methods that carry the placement ID to a payer. SOUNDBITE airs the product's audio and needs airing rules | |
| location | No | Descriptive, e.g. the venue or the address, up to 255 characters | |
| productId | Yes | The product's ID: pr + 8 letters or digits, e.g. pr7e4rCToG | |
| activeFrom | No | Start of its active window, ISO-8601 with an offset. Empty means the product's | |
| campaignId | No | The campaign it belongs to, if any (cp + 8 characters) | |
| useSandbox | No | Use the sandbox (the default) rather than production | |
| externalRef | No | An agency's own code, up to 100 characters |