Skip to main content

IssueHostedSetupLinkRequest

consentActorstringnullable
consentSourceSetupIntentConsentSourcenullable

Possible values: [CHECKOUT, VIRTUAL_TERMINAL, CUSTOMER_PORTAL, IMPORTED, UNKNOWN]

consentVersionstringnullable
customerIdstringnullable
deliveryModeHostedSetupLinkDeliveryModenullable

Possible values: [EMAIL, IFRAME]

emailstringnullable
externalCustomerRefstringnullable
externalRefSourceSetupIntentExternalRefSourcenullable

Possible values: [PEAK_POS]

locationIdstringnullable
merchantIdstringnullable
metadata objectnullable
property name*string
namestringnullable
ownerTypeSetupIntentOwnerTypenullable

Possible values: [CUSTOMER_MANAGED, MERCHANT_MANAGED]

phonestringnullable
recipientEmailstringnullable
replacementPaymentMethodIdstringnullable
usageTypeSetupIntentUsageTypenullable

Possible values: [OFF_SESSION, ON_SESSION]

IssueHostedSetupLinkRequest
{
  "consentActor": "string",
  "consentSource": "CHECKOUT",
  "consentVersion": "string",
  "customerId": "string",
  "deliveryMode": "EMAIL",
  "email": "string",
  "externalCustomerRef": "string",
  "externalRefSource": "PEAK_POS",
  "locationId": "string",
  "merchantId": "string",
  "metadata": {},
  "name": "string",
  "ownerType": "CUSTOMER_MANAGED",
  "phone": "string",
  "recipientEmail": "string",
  "replacementPaymentMethodId": "string",
  "usageType": "OFF_SESSION"
}