Skip to main content

SetupIntent

attemptsinteger<int32>
billingAddressRequiredbooleannullable
cancellationReasonstringnullable
cardEntryProviderCardEntryRouteProvider

Possible values: [DIRECT, ELAVON_EPG, UNKNOWN]

clientSecretstringnullable
createdAtstring<date-time>nullable
customerIdstringnullable
expiresAtstring<date-time>nullable
externalCustomerRefstringnullable
failedAtstring<date-time>nullable
failureReasonstringnullable
futureUseNoticestringnullable
futureUseNoticeVersionstringnullable
lastSetupError objectnullable
codestringrequired
declineCodestringnullable
messagestringrequired
networkStatusstringnullable
networkTransactionIdstringnullable
locationIdstringnullable
maxAttemptsinteger<int32>
merchantIdstringrequired
metadata objectrequired
property name*string
nextAction objectnullable
property name*anynullable
organizationIdstringrequired
originInvoiceIdstringnullable
paymentMethodIdstringnullable
purposeSavedPaymentMethodPurposenullable

Possible values: [ORDINARY_PAYMENT, INVOICE_ONLY, UNKNOWN]

setupIntentIdstringrequired
statusSetupIntentStatusrequired

Possible values: [REQUIRES_PAYMENT_METHOD, REQUIRES_CONFIRMATION, REQUIRES_ACTION, PROCESSING, SUCCEEDED, CANCELED, FAILED]

succeededAtstring<date-time>nullable
updatedAtstring<date-time>nullable
usageTypestringrequired
verification objectnullable
avsResultstringnullable
cvvResultstringnullable
verificationCurrencystringnullable
SetupIntent
{
  "attempts": 0,
  "billingAddressRequired": true,
  "cancellationReason": "string",
  "cardEntryProvider": "DIRECT",
  "clientSecret": "string",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "customerId": "string",
  "expiresAt": "2024-07-29T15:51:28.071Z",
  "externalCustomerRef": "string",
  "failedAt": "2024-07-29T15:51:28.071Z",
  "failureReason": "string",
  "futureUseNotice": "string",
  "futureUseNoticeVersion": "string",
  "lastSetupError": {
    "code": "string",
    "declineCode": "string",
    "message": "string",
    "networkStatus": "string",
    "networkTransactionId": "string"
  },
  "locationId": "string",
  "maxAttempts": 0,
  "merchantId": "string",
  "metadata": {},
  "nextAction": {},
  "organizationId": "string",
  "originInvoiceId": "string",
  "paymentMethodId": "string",
  "purpose": "ORDINARY_PAYMENT",
  "setupIntentId": "string",
  "status": "REQUIRES_PAYMENT_METHOD",
  "succeededAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "usageType": "string",
  "verification": {
    "avsResult": "string",
    "cvvResult": "string"
  },
  "verificationCurrency": "string"
}