When initiating a request for payment, for example, it is undesirable to permit modifying certain transaction parameters, such as payout destination, currency and quantity.
An intent can be created with a fixed set of economics and any other parameters, without reference a quote. This intent can then be shared with the user for them to fulfil. In the payment example this means passing the intent_id to the initialization object of the widget.
A default (but still user changeable) currency can be set for either side of the transaction by setting the default_transaction in the widget initialization.
Create Intent
GET/api/v1/partner/{public_api_key}/intent
Must contain `funding_settlement` and/or `payout_settlement`. Can only contain a quantity value for one.
Path Parameters
Name
Type
Description
public_api_key
string
Headers
Name
Type
Description
X-Quoine-Auth
string
Request Body
Name
Type
Description
funding_settlement
object
Object defining the funding information.
payout_settlement
object
Object defining the payout information.
strategy
string
Consumable strategy for this intent. Either `ONE_TO_ONE_ATTEMPTED` or `ONE_TO_MANY`
expires_at
number
Unix millisecond timestamp for expiring the intent.
partner_order_id
string
Optional searchable id. Max 40 characters.
partner_ref
string
Optional long string to be associated with the transaction.
partner_tags
array
Optional array of tags for items such as campaign id or product sku.
{"success": true,"environment": "SANDBOX","message": "Intent created. This intent can now be fulfilled by the widget.","payload": {"id":"d627cead-8298-441c-a85a-bdf9c664877a","created_at":"1623231760578","expires_at":null,"strategy":"ONE_TO_MANY","funding_settlement":null,"payout_settlement": {"method":"LIQUID_PARTNER_WALLET","currency":"JPY","quantity":"6540" },"partner_order_id":"searchable order id, max 40 characters","partner_ref":"Signed JWT","partner_tags": ["campaign_id" ] }}
{"token_id": "{created in Liquid web app, link above}","path": "/realtime","delegate_path": "/api/v1/partner/{public_api_key}/intent","nonce": {current unix timestamp}}
Strategy
The strategy field is optional, and defaults to ONE_TO_ONE_ATTEMPTED .
Strategy
Description
ONE_TO_ONE_ATTEMPTED
This causes the intent to be "consumed" the first time a user attempts to fulfil it. (Note: this refers to clicking "Buy now", not simply rendering the widget with the intent_id)
ONE_TO_MANY
This allows the intent to be reused multiple times. (Note: the partner_* fields will appear in each transaction created with the intent unless overridden in the widget configuration.)
Example
POST https://partners.liquid.com/api/v1/partner/{public_api_key}/intent{"partner_ref": "optional external reference","payout_settlement": {"method":"LIQUID_PARTNER_WALLET","currency":"JPY","quantity":"6500" }}200{"success": true,"environment": "SANDBOX","message": "Intent created. This intent can now be fulfilled by the widget.","payload": {"id":"d627cead-8298-441c-a85a-bdf9c664877a","created_at":"1623231760578","expires_at":null,"strategy":"ONE_TO_MANY","funding_settlement":null,"payout_settlement": {"method":"LIQUID_PARTNER_WALLET","currency":"JPY","quantity":"6540" },"partner_order_id":"searchable order id, max 40 characters","partner_ref":"Signed JWT","partner_tags": ["campaign_id" ] }}