Skip to main content
POST
/
api
/
v2
/
mandate
/
create
{
  "mandate_id": 123,
  "request_id": "<string>",
  "customer_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

Private API key for full access to SDK operations

Headers

​
x-request-id
string | null

Unique request identifier for tracing and debugging. Auto-generated if not provided.

​
x-user-id
string
required

End-user identifier within a customer organization. Required for user-scoped operations.

Body

application/json

Request body for creating a mandate record. All fields are optional to allow flexibility in mandate creation.

​
product
string | null

Product name or identifier

​
product_description
string | null

Detailed description of the product

​
price
number | null

Product price

​
currency
string | null

Currency code (ISO 4217)

​
merchant
string | null

Merchant name

​
merchant_link
string | null

Link to merchant website

​
confidence_score
number | null

AI confidence score for the transaction (0-1)

​
conversation_context
object | null

Context from the conversation that led to this mandate

​
human_messages
string[] | null

List of human messages from the conversation

​
additional_details
object | null

Any additional details relevant to the mandate

​
mode
enum<string>
default:live

Mandate mode: 'live' for production, 'sandbox' for testing

Available options:
live,
sandbox

Response

Successfully created mandate with unique ID and metadata

Mandate create response

​
mandate_id
integer
required
​
request_id
string
required
​
customer_id
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time> | null
required
⌘I