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.

Get one experience
GET/v3/experiences/{experience}
ModelsExpand Collapse
ExperienceListResponse object { experiences }
experiences: optional array of object { actions, display_name, experience }
actions: optional array of object { fields, name, summary }
fields: optional map[object { max, required, type } ]

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

max: optional number

Maximum length, for strings.

required: optional boolean
type: optional "string" or "cents" or "int"
One of the following:
"string"
"cents"
"int"
name: optional string
summary: optional string
display_name: optional string
experience: optional string
ExperienceRetrieveResponse object { 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: optional array of object { fields, name, summary }
fields: optional map[object { max, required, type } ]

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

max: optional number

Maximum length, for strings.

required: optional boolean
type: optional "string" or "cents" or "int"
One of the following:
"string"
"cents"
"int"
name: optional string
summary: optional string
display_name: optional string
experience: optional string