Skip to content
Get started

Experiences

Let an agent pay on a customer’s behalf with a single-use virtual card. Connect a customer once, then create a payment — a virtual card is minted scoped to that purchase and the card details are handed back for checkout.

List experiences you can invoke
client.experiences.list(RequestOptionsoptions?): ExperienceListResponse { experiences }
GET/v3/experiences
Get one experience
client.experiences.retrieve(stringexperience, RequestOptionsoptions?): ExperienceRetrieveResponse { actions, display_name, experience }
GET/v3/experiences/{experience}
ModelsExpand Collapse
ExperienceListResponse { experiences }
experiences?: Array<Experience>
actions?: Array<Action>
fields?: Record<string, Fields>

Fields you may send in params, keyed by the exact name to use.

max?: number

Maximum length, for strings.

required?: boolean
type?: "string" | "cents" | "int" | "url"
One of the following:
"string"
"cents"
"int"
"url"
name?: string
summary?: string
display_name?: string
experience?: string
ExperienceRetrieveResponse { actions, display_name, experience }

What an experience offers you. Deliberately a projection: where its templates live and how they are built is not yours to depend on, so it is not here.

actions?: Array<Action>
fields?: Record<string, Fields>

Fields you may send in params, keyed by the exact name to use.

max?: number

Maximum length, for strings.

required?: boolean
type?: "string" | "cents" | "int" | "url"
One of the following:
"string"
"cents"
"int"
"url"
name?: string
summary?: string
display_name?: string
experience?: string