CreateInstrumentRequest - LiteCore API Reference

Request body for creating a new payment instrument

holder_id

string

required

Holder ID (customer or beneficiary)

Example:

"holder_123456789"

payment_method

required

Credit or debit card

Allowed value: "card"

Example:

"card"

holder_type

required

End customer

Allowed value: "CUSTOMER"

Example:

"CUSTOMER"

pan_data

object

PAN (Primary Account Number) data for card tokenization

Show child attributes

data

string

Additional data (e.g., encrypted JWE token or device payment token)

Example:

"{\"version\":\"EC_v1\",\"data\":\"...\",\"signature\":\"...\",\"header\":{...}}"

agreement

object

Card-on-file agreement details for recurring or unscheduled transactions

Show child attributes

future_usage

Unscheduled recurring card-on-file transaction

Allowed value: "unscheduled_card_on_file"

Example:

"unscheduled_card_on_file"

CreateInstrumentResponseResponse returned after creating a new instrument

{ "holder_id": "holder_123456789", "payment_method": "card", "holder_type": "CUSTOMER", "data": "{\"version\":\"EC_v1\",\"data\":\"...\",\"signature\":\"...\",\"header\":{...}}", "agreement": { "reference": "custom-reference", "initial_transaction_reference": "transaction-reference-xxx" }, "future_usage": "unscheduled_card_on_file" }