InstrumentResponse - LiteCore API Reference

Full instrument details

string<uuid>

required

Unique instrument identifier

Example:

"550e8400-e29b-41d4-a716-446655440000"

merchant_id

string

required

Merchant that owns the instrument

Example:

"merch_123456789"

holder_id

string

required

Holder ID associated with the instrument

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"

status

required

Instrument has been created but not yet activated

Allowed value: "CREATED"

Example:

"ACTIVE"

created_at

string<date-time>

required

Timestamp when the instrument was created

Example:

"2024-01-01T00:00:00.000Z"

updated_at

string<date-time>

required

Timestamp of the last update to the instrument

Example:

"2024-01-01T00:00:00.000Z"

display

object

Masked display information for card instruments

Show child attributes

PanDataPAN (Primary Account Number) data for card tokenization

{ "id": "550e8400-e29b-41d4-a716-446655440000", "merchant_id": "merch_123456789", "holder_id": "holder_123456789", "payment_method": "card", "holder_type": "CUSTOMER", "status": "ACTIVE", "created_at": "2024-01-01T00:00:00.000Z", "updated_at": "2024-01-01T00:00:00.000Z", "display": { "expiry_year": "30", "expiry_month": "12", "scheme": "Visa", "last_4": "0018" } }