| GET | /customers | Find customers for currently logged in administrator | This service is used to get customers for the current user, the result will be paged if the query returns a to large set of values. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | query | Guid? | Yes | Enter the company and id you want to see the information for a customer, if blank company id and you are an admin, your company id will be used. If blank id, all resources will be shown |
| CustomerId | query | Guid? | No | Enter the customer id you want to see the information for a customer. Only admins are allowed to see all customers on their company, users can only see their own customer info. |
| UserId | query | Guid? | No | Enter the user id you want to see the information for a customer. Only admins are allowed to see all customers on their company, users can only see their own customer info. User Id is the userprofile |
| Search | query | string | Yes | Will search by any customer name,phone or email that contains the searchstring provided. |
| Visible | query | bool? | No | If you want to filter on visible customers. |
| IncludeCustomFieldValues | query | boolean | No | If you want to include the connected custom fields |
| IncludeCustomFields | query | boolean | No | If you want to include the connected custom fields |
| IncludeComments | query | boolean | No | If you want to include the comments on the customer |
| IncludeAccessKeys | query | bool | No | If you want to include the accesskeys |
| IncludeInvoiceAddress | query | bool | No | If you want to include invoice address |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | query | int | No | Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging. Example: ?skip=10&orderBy=Id |
| Take | query | int | No | Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: ?take=20 |
| OrderBy | query | string | No | Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field. Example: ?orderBy=Id,-Age,FirstName |
| OrderByDesc | query | string | No | Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field. Example: ?orderByDesc=Id,-Age,FirstName |
| Include | query | string | No | Include any of the aggregates AVG, COUNT, FIRST, LAST, MAX, MIN, SUM in your result set. The results will be returned in the meta field.Example: ?include=COUNT(*) as Totalor multiple fields with ?include=Count(*) Total, Min(Age), AVG(Age) AverageAgeor unique with ?include=COUNT(DISTINCT LivingStatus) as UniqueStatus |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IdentityId | form | int | No | |
| DeterministicId | form | Guid | No | |
| Id | form | Guid | No | |
| CustomerId | form | Guid | No | |
| AccessKeys | form | IList<UserAccessKeys> | Yes | |
| form | string | Yes | ||
| ExternalReferences | form | IList<ExternalReference> | Yes | |
| InvoiceAddress | form | IList<InvoiceAddress> | Yes | |
| MainInvoiceAddress | form | InvoiceAddress | Yes | |
| Company | form | Company | Yes | |
| CustomFieldsConfig | form | IList<CustomFieldConfig> | Yes | |
| CustomFieldsData | form | IList<CustomFieldDataResponse> | Yes | |
| Comments | form | IList<CustomerComment> | Yes | |
| RebateCodes | form | IList<RebateCode> | Yes | |
| Firstname | form | string | Yes | |
| FullName | form | string | Yes | |
| ImageUrl | form | string | Yes | |
| Active | form | bool | Yes | |
| FacebookUsername | form | string | No | |
| Updated | form | DateTime | Yes | |
| Created | form | DateTime | Yes | |
| IpAddress | form | string | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| TextField1 | form | string | No | |
| TextField2 | form | string | No | |
| TextField3 | form | string | No | |
| TextField4 | form | string | No | |
| TextField5 | form | string | No | |
| TextField6 | form | string | No | |
| TextField7 | form | string | No | |
| TextField8 | form | string | No | |
| TextField9 | form | string | No | |
| TextField10 | form | string | No | |
| TextField11 | form | string | No | |
| TextField12 | form | string | No | |
| TextField13 | form | string | No | |
| TextField14 | form | string | No | |
| TextField15 | form | string | No | |
| TextField16 | form | string | No | |
| TextField17 | form | string | No | |
| TextField18 | form | string | No | |
| TextField19 | form | string | No | |
| TextField20 | form | string | No | |
| UserId | form | Guid | No | |
| Lastname | form | string | No | |
| Phone | form | string | No | |
| CorporateIdentityNumber | form | string | No | |
| InvoiceAddress1 | form | string | No | |
| InvoiceAddress2 | form | string | No | |
| InvoiceCity | form | string | No | |
| InvoicePostalCode | form | string | No | |
| InvoiceCountryCode | form | string | No | |
| CompanyId | form | Guid | Yes | |
| SubscribedToNewsletter | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | Yes | |
| AccessKeyTypeId | form | int | Yes | |
| Value | form | string | Yes | |
| CustomerId | form | Guid | Yes | |
| Description | form | string | No | |
| Id | form | Guid | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | Yes | |
| Id | form | Guid | Yes | |
| OwnerId | form | Guid | Yes | |
| ReferenceType | form | string | Yes | |
| ReferenceTypeId | form | int | Yes | |
| ExternalData | form | string | No | |
| InternalData | form | string | No | |
| CreatedBy | form | string | No | |
| UpdatedDate | form | DateTime | Yes | |
| CreatedDate | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceAddressId | form | Guid | Yes | |
| CorporateIdentityNumber | form | string | No | |
| InvoiceAddress1 | form | string | No | |
| InvoiceAddress2 | form | string | No | |
| InvoiceCity | form | string | No | |
| InvoicePostalCode | form | string | No | |
| InvoiceCountryCode | form | string | No | |
| Main | form | bool | No | |
| UserId | form | Guid? | No | |
| CustomerId | form | Guid? | No | |
| UpdatedDate | form | DateTime | Yes | |
| CreatedDate | form | DateTime | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | form | CompanyStatus | No | |
| Active | form | bool | No | |
| CustomerCustomFieldsConfig | form | IList<CustomFieldConfig> | Yes | |
| BookingAgreements | form | string | Yes | |
| BookingSettings | form | BookingSettings | Yes | |
| CompanyType | form | CompanyType | Yes | |
| CodeLockSettings | form | CodeLockSetting | Yes | |
| PaymentSettings | form | PaymentSettings | Yes | |
| Settings | form | CompanySetting | Yes | |
| WidgetSettings | form | HomepageWidgetSetting | Yes | |
| HomepageSettings | form | HomepageSetting | Yes | |
| RatingScore | form | AverageRatingScore | Yes | |
| Ratings | form | List<Rating> | Yes | |
| Distance | form | double? | No | |
| Licenses | form | List<License> | Yes | |
| CompanyUsers | form | List<CompanyUser> | Yes | |
| ActiveLicenses | form | List<License> | Yes | |
| CurrentLicense | form | License | Yes | |
| IsFreeAccount | form | bool | No | |
| DefaultLanguage | form | CultureInfo | Yes | |
| Category | form | CompanyCategory | Yes | |
| Lat | form | double | No | |
| Lon | form | double | No | |
| IsFavorite | form | bool | No | |
| ExternalReferences | form | IList<ExternalReference> | Yes | |
| Id | form | Guid | Yes | |
| OrganisationNumber | form | string | Yes | |
| StatusId | form | int | Yes | |
| CategoryId | form | int | Yes | |
| SitePath | form | string | Yes | |
| Name | form | string | Yes | |
| Street1 | form | string | No | |
| Street2 | form | string | No | |
| ZipCode | form | string | No | |
| City | form | string | No | |
| OpeningHours | form | string | No | |
| FaxNumber | form | string | No | |
| form | string | Yes | ||
| Phone | form | string | No | |
| Details | form | string | No | |
| LogoType | form | string | No | |
| ApprovedByAdmin | form | bool | Yes | |
| Updated | form | DateTime | Yes | |
| Created | form | DateTime | Yes | |
| IpAddress | form | string | No | |
| Homepage | form | string | No | |
| DomainName | form | string | No | |
| CountryId | form | string | Yes | |
| CompanyOwnerId | form | int | Yes | |
| TypeId | form | int? | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| DeletionNotificationDate | form | DateTime? | No |
| Name | Value | |
|---|---|---|
| Registered | 1 | |
| AwaitingApproval | 2 | |
| Approved | 3 | |
| Inactive | 4 | |
| ClosedDown | 5 | |
| NotApproved | 6 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Values | form | List<CustomFieldValue> | Yes | |
| CustomField | form | CustomField | Yes | |
| RegEx | form | RegEx | Yes | |
| Services | form | List<Service> | Yes | |
| CustomFieldServiceRelation | form | List<CustomFieldServiceRelation> | Yes | |
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| GroupId | form | int? | No | |
| FieldId | form | int | Yes | |
| IconId | form | int | Yes | |
| RegExId | form | int? | No | |
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Datatype | form | string | Yes | |
| MaxLength | form | int | Yes | |
| IsPublic | form | bool | Yes | |
| IsHidden | form | bool | Yes | |
| IsMandatory | form | bool | Yes | |
| DefaultValue | form | string | No | |
| RegExErrorMessage | form | string | No | |
| MandatoryErrorMessage | form | string | No | |
| Width | form | int? | No | |
| MultipleLineText | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| Value | form | string | Yes | |
| Active | form | bool | Yes | |
| SortOrder | form | short? | No | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Table | form | string | Yes | |
| Column | form | string | Yes | |
| DataType | form | string | Yes | |
| Description | form | string | Yes | |
| Active | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| RegExCode | form | string | Yes | |
| ErrorMessage | form | string | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResourceTypes | form | List<ResourceType> | Yes | |
| Resources | form | IEnumerable<Resource> | Yes | |
| TotalPrice | form | TotalPriceInformation | Yes | |
| Prices | form | List<ServicePrice> | Yes | |
| BookingStatusOptions | form | List<BookingStatusOptions> | Yes | |
| IsGroupBooking | form | bool | No | |
| IsMultipleResource | form | bool | No | |
| Settings | form | BookingSettings | Yes | |
| PaymentSettings | form | PaymentSettings | Yes | |
| BookingCustomFieldsConfig | form | IList<CustomFieldConfig> | Yes | |
| CustomerCustomFieldsConfig | form | IList<CustomFieldConfig> | Yes | |
| CustomFieldsConfig | form | IList<CustomFieldConfig> | Yes | |
| CustomFieldsData | form | IList<CustomFieldDataResponse> | Yes | |
| Schedules | form | IList<ISchedule> | Yes | |
| CustomerActiveBookings | form | IList<Booking> | Yes | |
| ScheduleType | form | ScheduleType | No | |
| LastTimeToUnbookThreshold | form | TimeSpan | No | |
| LastTimeToBookThreshold | form | TimeSpan | No | |
| RatingScore | form | AverageRatingScore | Yes | |
| Ratings | form | List<Rating> | Yes | |
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Group | form | string | No | |
| Active | form | bool | Yes | |
| SortOrder | form | int | Yes | |
| PauseAfterBooking | form | int | Yes | |
| UnbookBeforeDays | form | int | Yes | |
| UnbookBeforeHours | form | int | Yes | |
| UnbookBeforeMinutes | form | int | Yes | |
| BookBeforeDays | form | int | Yes | |
| BookBeforeHours | form | int | Yes | |
| BookBeforeMinutes | form | int | Yes | |
| Duration | form | int? | No | |
| DurationTypeId | form | int | No | |
| MinDuration | form | int? | No | |
| MaxDuration | form | int? | No | |
| DurationInterval | form | int? | No | |
| TotalSpots | form | int? | No | |
| ImageUrl | form | string | No | |
| ScheduleTypeId | form | int | Yes | |
| UpdatedDate | form | DateTime | Yes | |
| CreatedDate | form | DateTime | Yes | |
| OnlyVisibleByAdmin | form | bool | Yes | |
| MinNumberOfSpotsPerBooking | form | int | Yes | |
| MaxNumberOfSpotsPerBooking | form | int | Yes | |
| MinNumberOfResourcesToBook | form | int | Yes | |
| MaxNumberOfResourcesToBook | form | int | Yes | |
| IsPaymentEnabled | form | bool | Yes | |
| MaxPaymentTime | form | int | Yes | |
| LockSpotsToBooking | form | bool | Yes | |
| EnableBookingQueue | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| BookingStatusId | form | int | Yes | |
| EnableCodeLockSync | form | bool | Yes | |
| EnableCustomerManualPayment | form | bool | Yes | |
| PriceViewTypeId | form | int? | No | |
| TextField1 | form | string | No | |
| TextField2 | form | string | No | |
| TextField3 | form | string | No | |
| TextField4 | form | string | No | |
| TextField5 | form | string | No | |
| TextField6 | form | string | No | |
| TextField7 | form | string | No | |
| TextField8 | form | string | No | |
| TextField9 | form | string | No | |
| TextField10 | form | string | No | |
| TextField11 | form | string | No | |
| TextField12 | form | string | No | |
| TextField13 | form | string | No | |
| TextField14 | form | string | No | |
| TextField15 | form | string | No | |
| TextField16 | form | string | No | |
| TextField17 | form | string | No | |
| TextField18 | form | string | No | |
| TextField19 | form | string | No | |
| TextField20 | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SelectableByUser | form | bool | No | |
| Resources | form | List<Resource> | Yes | |
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| Name | form | string | Yes | |
| Description | form | string | No | |
| Active | form | bool | Yes | |
| UpdatedDate | form | DateTime | Yes | |
| CreatedDate | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Priority | form | int | No | |
| Schedules | form | IList<ISchedule> | Yes | |
| Exceptions | form | IList<ITimeException> | Yes | |
| Bookings | form | IList<IBookedTime> | Yes | |
| CustomFieldsConfig | form | IList<CustomFieldConfig> | Yes | |
| CustomFieldsData | form | IList<CustomFieldDataResponse> | Yes | |
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| Name | form | string | Yes | |
| Active | form | bool | Yes | |
| Description | form | string | No | |
| ImageUrl | form | string | No | |
| UpdatedDate | form | DateTime | Yes | |
| CreatedDate | form | DateTime | Yes | |
| Color | form | string | Yes | |
| form | string | No | ||
| MobilePhone | form | string | No | |
| EmailNotification | form | bool? | No | |
| SMSNotification | form | bool? | No | |
| SendSMSReminder | form | bool | Yes | |
| SendEmailReminder | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| AccessGroup | form | string | No | |
| TextField1 | form | string | No | |
| TextField2 | form | string | No | |
| TextField3 | form | string | No | |
| TextField4 | form | string | No | |
| TextField5 | form | string | No | |
| TextField6 | form | string | No | |
| TextField7 | form | string | No | |
| TextField8 | form | string | No | |
| TextField9 | form | string | No | |
| TextField10 | form | string | No | |
| TextField11 | form | string | No | |
| TextField12 | form | string | No | |
| TextField13 | form | string | No | |
| TextField14 | form | string | No | |
| TextField15 | form | string | No | |
| TextField16 | form | string | No | |
| TextField17 | form | string | No | |
| TextField18 | form | string | No | |
| TextField19 | form | string | No | |
| TextField20 | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | No | |
| Resources | form | IList<Resource> | Yes | |
| Type | form | ScheduleType | No | |
| Active | form | bool | No | |
| IsResourceSpecific | form | bool | No |
| NotDefined | |
| RecurringSchedule | |
| DateSchedule |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| ReasonText | form | string | Yes | |
| IsBlock | form | bool | No | |
| ReasonTextPublic | form | string | Yes | |
| IsRecurring | form | bool | No | |
| ResourceIds | form | int[] | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| ServiceId | form | int | No | |
| BookedSpots | form | int | No | |
| TotalSpots | form | int | No | |
| PauseAfterInMinutes | form | int | No | |
| Status | form | BookingStatusEnum | No | |
| StatusId | form | int | No | |
| Customer | form | BookedCustomer | Yes |
| Name | Value | |
|---|---|---|
| Booked | 1 | |
| Unbooked | 2 | |
| Reserved | 3 | |
| Canceled | 4 | |
| AwaitingPayment | 5 | |
| AwaitingPaymentNoTimeLimit | 6 | |
| Payed | 7 | |
| AwaitingPaymentRequestFromAdmin | 8 | |
| AwaitingPaymentFromProvider | 9 | |
| Invoiced | 10 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Firstname | form | string | Yes | |
| Lastname | form | string | Yes | |
| form | string | Yes | ||
| Phone | form | string | Yes | |
| FacebookUserName | form | string | Yes | |
| ImageUrl | form | string | Yes | |
| CorporateIdentityNumber | form | string | Yes | |
| InvoiceAddress1 | form | string | Yes | |
| InvoiceAddress2 | form | string | Yes | |
| InvoiceCity | form | string | Yes | |
| InvoicePostalCode | form | string | Yes | |
| InvoiceCountryCode | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Column | form | string | Yes | |
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Value | form | string | Yes | |
| DataType | form | string | Yes | Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox' |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalPrice | form | double | No | |
| TotalVATAmount | form | double | No | |
| TotalRebate | form | double | No | |
| TotalPriceBeforeRebate | form | double | No | |
| AppliedCodes | form | List<AppliedRebateCodes> | Yes | |
| PriceSign | form | string | Yes | |
| CurrencyId | form | string | Yes | |
| VAT | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RebateCodeId | form | int | No | |
| RebateCodeSign | form | string | Yes | |
| RebateCodeValue | form | int | No | |
| RebateAmount | form | double | No | |
| RebateCodeType | form | RebateCodeType | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurrencyId | form | string | Yes | |
| CurrencyInfo | form | Currency | Yes | |
| Service | form | Service | Yes | |
| PriceMappings | form | List<PriceMapping> | Yes | |
| isTimeSpecific | form | bool | No | |
| isDaysOfWeekSpecific | form | bool | No | |
| DayOfWeeks | form | List<ServicePriceDayOfWeekRelation> | Yes | |
| PriceBeforeRebate | form | double? | No | |
| RebateCodesApplied | form | List<RebateCode> | Yes | |
| PriceText | form | string | Yes | |
| OverlappingPrices | form | List<ServicePrice> | Yes | |
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| ServiceId | form | int | Yes | |
| Price | form | double? | No | |
| Updated | form | DateTime | Yes | |
| Created | form | DateTime | Yes | |
| FromTime | form | TimeSpan | Yes | |
| ToTime | form | TimeSpan | Yes | |
| VAT | form | decimal | Yes | |
| Category | form | string | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| From | form | DateTime | Yes | |
| To | form | DateTime | Yes | |
| CalculationTypeId | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| CurrencySign | form | string | Yes | |
| Active | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | Yes | |
| Id | form | Guid | Yes | |
| ServicePriceId | form | int | Yes | |
| ReferenceType | form | string | No | |
| ExternalReference | form | string | No | |
| UpdatedDate | form | DateTime | Yes | |
| CreatedDate | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DayOfWeek | form | BokaMeraDayOfWeek | No | |
| CompanyId | form | Guid | Yes | |
| ServicePriceId | form | int | Yes | |
| DayOfWeekId | form | int | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Value | |
|---|---|---|
| Monday | 1 | |
| Tuesday | 2 | |
| Wednesday | 3 | |
| Thursday | 4 | |
| Friday | 5 | |
| Saturday | 6 | |
| Sunday | 7 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RebateCodeTypeId | form | int | No | |
| RebateCodeTypeInfo | form | RebateCodeType | Yes | |
| RebateCodeStatusId | form | int | No | |
| RebateCodeStatusInfo | form | RebateCodeStatus | Yes | |
| RebateCodeDayOfWeekRelation | form | List<RebateCodeDayOfWeekRelation> | Yes | |
| RebateCodeServiceRelation | form | List<RebateCodeServiceRelation> | Yes | |
| RebateCodeBookingPriceRelation | form | List<RebateCodeBookingPriceRelation> | Yes | |
| RebateCodeCustomerRelation | form | List<RebateCodeCustomerRelation> | Yes | |
| DaysOfWeek | form | List<DaysOfWeek> | Yes | |
| RebateCodeStatus | form | RebateCodeStatus | Yes | |
| RebateCodeType | form | RebateCodeType | Yes | |
| Transactions | form | List<RebateCodeTransaction> | Yes | |
| RemainingAmount | form | double? | No | |
| RemainingUsage | form | int? | No | |
| CurrentNumberOfUsesPerCustomer | form | int | No | |
| IsSpecificByDayOfWeek | form | bool | No | |
| Active | form | bool | No | |
| ActiveByStatus | form | bool | No | |
| RebateCodeCurrencySign | form | string | Yes | |
| PaymentReceived | form | bool | No | |
| InternalReferenceId | form | string | Yes | |
| ValidFrom | form | DateTime | Yes | |
| ValidTo | form | DateTime | Yes | |
| RebateCodeSign | form | string | Yes | |
| RebateCodeValue | form | int | Yes | |
| MaxNumberOfUses | form | int | Yes | |
| MaxNumberOfUsesPerCustomer | form | int | Yes | |
| NumberOfUsesUsed | form | int | Yes | |
| PersonalNote | form | string | No | |
| CreatedBy | form | string | Yes | |
| UpdatedBy | form | string | Yes | |
| FromTime | form | TimeSpan | Yes | |
| ToTime | form | TimeSpan | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No | |
| ArticleId | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DbFactory | form | IDbConnectionFactory | Yes | |
| ArticlePaymentSettings | form | ArticlePaymentSettings | Yes | |
| QvicklyPaymentManager | form | IBokameraPaymentManager<InitCheckoutRequestBody, QvicklyCustomCheckoutData, QvicklyCustomCheckoutData> | Yes | |
| StripePaymentManager | form | IBokameraPaymentManager<StripeCreateCheckoutQuery, StripeCustomCheckoutData, StripeCustomCheckoutData> | Yes | |
| Logger | form | ILogger<PayableEntity> | Yes | |
| CacheProvider | form | CacheDataProvider | Yes | |
| ServicesNames | form | string | Yes | |
| InternalReferenceId | form | string | Yes | |
| PaymentLog | form | List<PaymentLog> | Yes | |
| ArticleType | form | ArticleType | Yes | |
| CompanyId | form | Guid | No | |
| UpdatedDate | form | DateTime | Yes | |
| CreatedDate | form | DateTime | Yes | |
| PriceVat | form | decimal? | No | |
| CurrencyId | form | string | Yes | |
| CurrencyInfo | form | Currency | Yes | |
| Customer | form | Customer | No | |
| Customers | form | List<Customer> | No | |
| Company | form | Company | Yes | |
| Services | form | List<Service> | Yes | |
| Article | form | Article | Yes | |
| InvoiceAddress | form | ArticleInvoiceAddress | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WeeksBeforeArticleIsCancelled | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| credentials | form | Credentials | Yes | |
| data | form | InitCheckoutData | Yes | |
| function | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| hash | form | string | Yes | |
| id | form | string | Yes | |
| version | form | string | Yes | |
| client | form | string | Yes | |
| serverdata | form | ServerData | Yes | |
| time | form | string | Yes | |
| test | form | string | Yes | |
| language | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HTTP_HOST | form | string | Yes | |
| HTTP_CONNECTION | form | string | Yes | |
| HTTP_CACHE_CONTROL | form | string | Yes | |
| HTTP_ACCEPT | form | string | Yes | |
| HTTP_USER_AGENT | form | string | Yes | |
| HTTP_ACCEPT_ENCODING | form | string | Yes | |
| HTTP_ACCEPT_LANGUAGE | form | string | Yes | |
| PATH | form | string | Yes | |
| SERVER_SOFTWARE | form | string | Yes | |
| SERVER_NAME | form | string | Yes | |
| SERVER_ADDR | form | string | Yes | |
| SERVER_PORT | form | string | Yes | |
| REMOTE_ADDR | form | string | Yes | |
| REMOTE_PORT | form | string | Yes | |
| GATEWAY_INTERFACE | form | string | Yes | |
| SERVER_PROTOCOL | form | string | Yes | |
| REQUEST_METHOD | form | string | Yes | |
| QUERY_STRING | form | string | Yes | |
| REQUEST_TIME | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CheckoutData | form | CheckoutData | Yes | |
| PaymentData | form | CheckoutPaymentData | Yes | |
| PaymentInfo | form | PaymentInfo | Yes | |
| Articles | form | QvicklyArticle[] | Yes | |
| Cart | form | Cart | Yes | |
| QvicklyCustomer | form | QvicklyCustomer | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| terms | form | Uri | Yes | |
| privacyPolicy | form | Uri | Yes | |
| redirectOnSuccess | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| currency | form | string | Yes | |
| language | form | string | Yes | |
| country | form | string | Yes | |
| autoactivate | form | string | Yes | |
| orderid | form | string | Yes | |
| returnmethod | form | string | Yes | |
| accepturl | form | string | Yes | |
| cancelurl | form | string | Yes | |
| callbackurl | form | Uri | Yes | |
| invoice | form | CheckoutInvoice | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| number | form | string | No | |
| status | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| paymentdate | form | string | Yes | |
| paymentterms | form | string | Yes | |
| yourreference | form | string | Yes | |
| ourreference | form | string | Yes | |
| projectname | form | string | Yes | |
| deliverymethod | form | string | Yes | |
| deliveryterms | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| artnr | form | string | Yes | |
| title | form | string | Yes | |
| quantity | form | int | No | |
| aprice | form | int | No | |
| tax | form | int | No | |
| discount | form | int | No | |
| withouttax | form | int | No | |
| taxrate | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Handling | form | CartHandling | Yes | |
| Total | form | CartTotal | Yes | |
| Shipping | form | Shipping | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| withouttax | form | string | Yes | |
| taxrate | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| rounding | form | decimal | No | |
| withouttax | form | int | No | |
| tax | form | int | No | |
| withtax | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| firstname | form | string | Yes | |
| lastname | form | string | Yes | |
| company | form | string | Yes | |
| street | form | string | Yes | |
| street2 | form | string | Yes | |
| zip | form | string | Yes | |
| city | form | string | Yes | |
| country | form | string | Yes | |
| phone | form | string | Yes | |
| withouttax | form | string | Yes | |
| taxrate | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| nr | form | string | Yes | |
| pno | form | string | Yes | |
| Billing | form | CustomerBilling | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| firstname | form | string | Yes | |
| lastname | form | string | Yes | |
| company | form | string | Yes | |
| street | form | string | Yes | |
| street2 | form | string | Yes | |
| zip | form | string | Yes | |
| city | form | string | Yes | |
| country | form | string | Yes | |
| phone | form | string | Yes | |
| form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| QvicklyCheckoutResponse | form | GetCheckoutResponse | No | |
| InitCheckoutResponse | form | InitCheckoutResponse | No | |
| QvicklyPaymentResponse | form | QvicklyPaymentResponse | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| credentials | form | Credentials | Yes | |
| GetCheckoutData | form | GetCheckoutData | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Hash | form | string | Yes | |
| Logid | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CheckoutData | form | CheckoutData | Yes | |
| PaymentData | form | CheckoutPaymentData | Yes | |
| Articles | form | List<QvicklyArticle> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Number | form | int | No | |
| Status | form | string | Yes | |
| OrderId | form | string | Yes | |
| Url | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentData | form | QvikclyPaymentData | Yes | |
| PaymentInfo | form | PaymentInfo | Yes | |
| Card | form | Card | Yes | |
| Settlement | form | Settlement | Yes | |
| QvicklyCustomer | form | QvicklyCustomer | Yes | |
| Articles | form | QvicklyArticle[] | Yes | |
| Cart | form | Cart | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| method | form | string | Yes | |
| paymentplanid | form | string | Yes | |
| currency | form | string | Yes | |
| country | form | string | Yes | |
| language | form | string | Yes | |
| autoactivate | form | string | Yes | |
| orderid | form | string | Yes | |
| status | form | string | Yes | |
| paymentid_related | form | string | Yes | |
| url | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| promptname | form | string | Yes | |
| recurring | form | string | Yes | |
| recurringnr | form | string | Yes | |
| accepturl | form | string | Yes | |
| cancelurl | form | string | Yes | |
| callbackurl | form | string | Yes | |
| returnmethod | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| number | form | int | No | |
| date | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CheckoutData | form | StripeCreatePaymentOptions | Yes | |
| RequestOptions | form | RequestOptions | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SessionCreateOptions | form | SessionCreateOptions | No | |
| PaymentIntentCreateOptions | form | PaymentIntentCreateOptions | No | |
| CustomerCreateOptions | form | CustomerCreateOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AdaptivePricing | form | SessionAdaptivePricingOptions | No | |
| AfterExpiration | form | SessionAfterExpirationOptions | No | |
| AllowPromotionCodes | form | bool? | No | |
| AutomaticTax | form | SessionAutomaticTaxOptions | No | |
| BillingAddressCollection | form | string | No | |
| CancelUrl | form | string | No | |
| ClientReferenceId | form | string | No | |
| ConsentCollection | form | SessionConsentCollectionOptions | No | |
| Currency | form | string | No | |
| CustomFields | form | List<SessionCustomFieldOptions> | No | |
| CustomText | form | SessionCustomTextOptions | No | |
| Customer | form | string | No | |
| CustomerCreation | form | string | No | |
| CustomerEmail | form | string | No | |
| CustomerUpdate | form | SessionCustomerUpdateOptions | No | |
| Discounts | form | List<SessionDiscountOptions> | No | |
| ExpiresAt | form | DateTime? | No | |
| InvoiceCreation | form | SessionInvoiceCreationOptions | No | |
| LineItems | form | List<SessionLineItemOptions> | No | |
| Locale | form | string | No | |
| Metadata | form | Dictionary<string, string> | No | |
| Mode | form | string | No | |
| OptionalItems | form | List<SessionOptionalItemOptions> | No | |
| PaymentIntentData | form | SessionPaymentIntentDataOptions | No | |
| PaymentMethodCollection | form | string | No | |
| PaymentMethodConfiguration | form | string | No | |
| PaymentMethodData | form | SessionPaymentMethodDataOptions | No | |
| PaymentMethodOptions | form | SessionPaymentMethodOptionsOptions | No | |
| PaymentMethodTypes | form | List<string> | No | |
| Permissions | form | SessionPermissionsOptions | No | |
| PhoneNumberCollection | form | SessionPhoneNumberCollectionOptions | No | |
| RedirectOnCompletion | form | string | No | |
| ReturnUrl | form | string | No | |
| SavedPaymentMethodOptions | form | SessionSavedPaymentMethodOptionsOptions | No | |
| SetupIntentData | form | SessionSetupIntentDataOptions | No | |
| ShippingAddressCollection | form | SessionShippingAddressCollectionOptions | No | |
| ShippingOptions | form | List<SessionShippingOptionOptions> | No | |
| SubmitType | form | string | No | |
| SubscriptionData | form | SessionSubscriptionDataOptions | No | |
| SuccessUrl | form | string | No | |
| TaxIdCollection | form | SessionTaxIdCollectionOptions | No | |
| UiMode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExtraParams | form | IDictionary<string, Object> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Recovery | form | SessionAfterExpirationRecoveryOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowPromotionCodes | form | bool? | No | |
| Enabled | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool? | No | |
| Liability | form | SessionAutomaticTaxLiabilityOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Account | form | string | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentMethodReuseAgreement | form | SessionConsentCollectionPaymentMethodReuseAgreementOptions | No | |
| Promotions | form | string | No | |
| TermsOfService | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Position | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Dropdown | form | SessionCustomFieldDropdownOptions | No | |
| Key | form | string | No | |
| Label | form | SessionCustomFieldLabelOptions | No | |
| Numeric | form | SessionCustomFieldNumericOptions | No | |
| Optional | form | bool? | No | |
| Text | form | SessionCustomFieldTextOptions | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DefaultValue | form | string | No | |
| Options | form | List<SessionCustomFieldDropdownOptionOptions> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Custom | form | string | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DefaultValue | form | string | No | |
| MaximumLength | form | long? | No | |
| MinimumLength | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DefaultValue | form | string | No | |
| MaximumLength | form | long? | No | |
| MinimumLength | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AfterSubmit | form | SessionCustomTextAfterSubmitOptions | No | |
| ShippingAddress | form | SessionCustomTextShippingAddressOptions | No | |
| Submit | form | SessionCustomTextSubmitOptions | No | |
| TermsOfServiceAcceptance | form | SessionCustomTextTermsOfServiceAcceptanceOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | string | No | |
| Name | form | string | No | |
| Shipping | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Coupon | form | string | No | |
| PromotionCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool? | No | |
| InvoiceData | form | SessionInvoiceCreationInvoiceDataOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountTaxIds | form | List<string> | No | |
| CustomFields | form | List<SessionInvoiceCreationInvoiceDataCustomFieldOptions> | No | |
| Description | form | string | No | |
| Footer | form | string | No | |
| Issuer | form | SessionInvoiceCreationInvoiceDataIssuerOptions | No | |
| Metadata | form | Dictionary<string, string> | No | |
| RenderingOptions | form | SessionInvoiceCreationInvoiceDataRenderingOptionsOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Account | form | string | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmountTaxDisplay | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AdjustableQuantity | form | SessionLineItemAdjustableQuantityOptions | No | |
| DynamicTaxRates | form | List<string> | No | |
| Price | form | string | No | |
| PriceData | form | SessionLineItemPriceDataOptions | No | |
| Quantity | form | long? | No | |
| TaxRates | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool? | No | |
| Maximum | form | long? | No | |
| Minimum | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Currency | form | string | No | |
| Product | form | string | No | |
| ProductData | form | SessionLineItemPriceDataProductDataOptions | No | |
| Recurring | form | SessionLineItemPriceDataRecurringOptions | No | |
| TaxBehavior | form | string | No | |
| UnitAmount | form | long? | No | |
| UnitAmountDecimal | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Images | form | List<string> | No | |
| Metadata | form | Dictionary<string, string> | No | |
| Name | form | string | No | |
| TaxCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Interval | form | string | No | |
| IntervalCount | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AdjustableQuantity | form | SessionOptionalItemAdjustableQuantityOptions | No | |
| Price | form | string | No | |
| Quantity | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool? | No | |
| Maximum | form | long? | No | |
| Minimum | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApplicationFeeAmount | form | long? | No | |
| CaptureMethod | form | string | No | |
| Description | form | string | No | |
| Metadata | form | Dictionary<string, string> | No | |
| OnBehalfOf | form | string | No | |
| ReceiptEmail | form | string | No | |
| SetupFutureUsage | form | string | No | |
| Shipping | form | ChargeShippingOptions | No | |
| StatementDescriptor | form | string | No | |
| StatementDescriptorSuffix | form | string | No | |
| TransferData | form | SessionPaymentIntentDataTransferDataOptions | No | |
| TransferGroup | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | AddressOptions | No | |
| Carrier | form | string | No | |
| Name | form | string | No | |
| Phone | form | string | No | |
| TrackingNumber | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| City | form | string | No | |
| Country | form | string | No | |
| Line1 | form | string | No | |
| Line2 | form | string | No | |
| PostalCode | form | string | No | |
| State | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long? | No | |
| Destination | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowRedisplay | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcssDebit | form | SessionPaymentMethodOptionsAcssDebitOptions | No | |
| Affirm | form | SessionPaymentMethodOptionsAffirmOptions | No | |
| AfterpayClearpay | form | SessionPaymentMethodOptionsAfterpayClearpayOptions | No | |
| Alipay | form | SessionPaymentMethodOptionsAlipayOptions | No | |
| AmazonPay | form | SessionPaymentMethodOptionsAmazonPayOptions | No | |
| AuBecsDebit | form | SessionPaymentMethodOptionsAuBecsDebitOptions | No | |
| BacsDebit | form | SessionPaymentMethodOptionsBacsDebitOptions | No | |
| Bancontact | form | SessionPaymentMethodOptionsBancontactOptions | No | |
| Boleto | form | SessionPaymentMethodOptionsBoletoOptions | No | |
| Card | form | SessionPaymentMethodOptionsCardOptions | No | |
| Cashapp | form | SessionPaymentMethodOptionsCashappOptions | No | |
| CustomerBalance | form | SessionPaymentMethodOptionsCustomerBalanceOptions | No | |
| Eps | form | SessionPaymentMethodOptionsEpsOptions | No | |
| Fpx | form | SessionPaymentMethodOptionsFpxOptions | No | |
| Giropay | form | SessionPaymentMethodOptionsGiropayOptions | No | |
| Grabpay | form | SessionPaymentMethodOptionsGrabpayOptions | No | |
| Ideal | form | SessionPaymentMethodOptionsIdealOptions | No | |
| KakaoPay | form | SessionPaymentMethodOptionsKakaoPayOptions | No | |
| Klarna | form | SessionPaymentMethodOptionsKlarnaOptions | No | |
| Konbini | form | SessionPaymentMethodOptionsKonbiniOptions | No | |
| KrCard | form | SessionPaymentMethodOptionsKrCardOptions | No | |
| Link | form | SessionPaymentMethodOptionsLinkOptions | No | |
| Mobilepay | form | SessionPaymentMethodOptionsMobilepayOptions | No | |
| Multibanco | form | SessionPaymentMethodOptionsMultibancoOptions | No | |
| NaverPay | form | SessionPaymentMethodOptionsNaverPayOptions | No | |
| Oxxo | form | SessionPaymentMethodOptionsOxxoOptions | No | |
| P24 | form | SessionPaymentMethodOptionsP24Options | No | |
| PayByBank | form | SessionPaymentMethodOptionsPayByBankOptions | No | |
| Payco | form | SessionPaymentMethodOptionsPaycoOptions | No | |
| Paynow | form | SessionPaymentMethodOptionsPaynowOptions | No | |
| Paypal | form | SessionPaymentMethodOptionsPaypalOptions | No | |
| Pix | form | SessionPaymentMethodOptionsPixOptions | No | |
| RevolutPay | form | SessionPaymentMethodOptionsRevolutPayOptions | No | |
| SamsungPay | form | SessionPaymentMethodOptionsSamsungPayOptions | No | |
| SepaDebit | form | SessionPaymentMethodOptionsSepaDebitOptions | No | |
| Sofort | form | SessionPaymentMethodOptionsSofortOptions | No | |
| Swish | form | SessionPaymentMethodOptionsSwishOptions | No | |
| UsBankAccount | form | SessionPaymentMethodOptionsUsBankAccountOptions | No | |
| WechatPay | form | SessionPaymentMethodOptionsWechatPayOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Currency | form | string | No | |
| MandateOptions | form | SessionPaymentMethodOptionsAcssDebitMandateOptionsOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No | |
| VerificationMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomMandateUrl | form | string | No | |
| DefaultFor | form | List<string> | No | |
| IntervalDescription | form | string | No | |
| PaymentSchedule | form | string | No | |
| TransactionType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | SessionPaymentMethodOptionsBacsDebitMandateOptionsOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReferencePrefix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterDays | form | long? | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Installments | form | SessionPaymentMethodOptionsCardInstallmentsOptions | No | |
| RequestExtendedAuthorization | form | string | No | |
| RequestIncrementalAuthorization | form | string | No | |
| RequestMulticapture | form | string | No | |
| RequestOvercapture | form | string | No | |
| RequestThreeDSecure | form | string | No | |
| Restrictions | form | SessionPaymentMethodOptionsCardRestrictionsOptions | No | |
| SetupFutureUsage | form | string | No | |
| StatementDescriptorSuffixKana | form | string | No | |
| StatementDescriptorSuffixKanji | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BrandsBlocked | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BankTransfer | form | SessionPaymentMethodOptionsCustomerBalanceBankTransferOptions | No | |
| FundingType | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EuBankTransfer | form | SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferOptions | No | |
| RequestedAddressTypes | form | List<string> | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Country | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterDays | form | long? | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterDays | form | long? | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No | |
| TosShownAndAccepted | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| PreferredLocale | form | string | No | |
| Reference | form | string | No | |
| RiskCorrelationId | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterSeconds | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | SessionPaymentMethodOptionsSepaDebitMandateOptionsOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReferencePrefix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FinancialConnections | form | SessionPaymentMethodOptionsUsBankAccountFinancialConnectionsOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No | |
| VerificationMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Permissions | form | List<string> | No | |
| Prefetch | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AppId | form | string | No | |
| Client | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UpdateShippingDetails | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowRedisplayFilters | form | List<string> | No | |
| PaymentMethodSave | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Metadata | form | Dictionary<string, string> | No | |
| OnBehalfOf | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowedCountries | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShippingRate | form | string | No | |
| ShippingRateData | form | SessionShippingOptionShippingRateDataOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DeliveryEstimate | form | SessionShippingOptionShippingRateDataDeliveryEstimateOptions | No | |
| DisplayName | form | string | No | |
| FixedAmount | form | SessionShippingOptionShippingRateDataFixedAmountOptions | No | |
| Metadata | form | Dictionary<string, string> | No | |
| TaxBehavior | form | string | No | |
| TaxCode | form | string | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Maximum | form | SessionShippingOptionShippingRateDataDeliveryEstimateMaximumOptions | No | |
| Minimum | form | SessionShippingOptionShippingRateDataDeliveryEstimateMinimumOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Unit | form | string | No | |
| Value | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Unit | form | string | No | |
| Value | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long? | No | |
| Currency | form | string | No | |
| CurrencyOptions | form | Dictionary<string, SessionShippingOptionShippingRateDataFixedAmountCurrencyOptionsOptions> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long? | No | |
| TaxBehavior | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApplicationFeePercent | form | decimal? | No | |
| BillingCycleAnchor | form | DateTime? | No | |
| DefaultTaxRates | form | List<string> | No | |
| Description | form | string | No | |
| InvoiceSettings | form | SessionSubscriptionDataInvoiceSettingsOptions | No | |
| Metadata | form | Dictionary<string, string> | No | |
| OnBehalfOf | form | string | No | |
| ProrationBehavior | form | string | No | |
| TransferData | form | SessionSubscriptionDataTransferDataOptions | No | |
| TrialEnd | form | DateTime? | No | |
| TrialPeriodDays | form | long? | No | |
| TrialSettings | form | SessionSubscriptionDataTrialSettingsOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Issuer | form | SessionSubscriptionDataInvoiceSettingsIssuerOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Account | form | string | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmountPercent | form | decimal? | No | |
| Destination | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EndBehavior | form | SessionSubscriptionDataTrialSettingsEndBehaviorOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MissingPaymentMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool? | No | |
| Required | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long? | No | |
| ApplicationFeeAmount | form | long? | No | |
| AutomaticPaymentMethods | form | PaymentIntentAutomaticPaymentMethodsOptions | No | |
| CaptureMethod | form | string | No | |
| Confirm | form | bool? | No | |
| ConfirmationMethod | form | string | No | |
| ConfirmationToken | form | string | No | |
| Currency | form | string | No | |
| Customer | form | string | No | |
| Description | form | string | No | |
| ErrorOnRequiresAction | form | bool? | No | |
| Mandate | form | string | No | |
| MandateData | form | PaymentIntentMandateDataOptions | No | |
| Metadata | form | Dictionary<string, string> | No | |
| OffSession | form | bool? | No | |
| OnBehalfOf | form | string | No | |
| PaymentMethod | form | string | No | |
| PaymentMethodConfiguration | form | string | No | |
| PaymentMethodData | form | PaymentIntentPaymentMethodDataOptions | No | |
| PaymentMethodOptions | form | PaymentIntentPaymentMethodOptionsOptions | No | |
| PaymentMethodTypes | form | List<string> | No | |
| RadarOptions | form | PaymentIntentRadarOptionsOptions | No | |
| ReceiptEmail | form | string | No | |
| ReturnUrl | form | string | No | |
| SetupFutureUsage | form | string | No | |
| Shipping | form | ChargeShippingOptions | No | |
| StatementDescriptor | form | string | No | |
| StatementDescriptorSuffix | form | string | No | |
| TransferData | form | PaymentIntentTransferDataOptions | No | |
| TransferGroup | form | string | No | |
| UseStripeSdk | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowRedirects | form | string | No | |
| Enabled | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerAcceptance | form | PaymentIntentMandateDataCustomerAcceptanceOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcceptedAt | form | DateTime? | No | |
| Offline | form | PaymentIntentMandateDataCustomerAcceptanceOfflineOptions | No | |
| Online | form | PaymentIntentMandateDataCustomerAcceptanceOnlineOptions | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IpAddress | form | string | No | |
| UserAgent | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcssDebit | form | PaymentIntentPaymentMethodDataAcssDebitOptions | No | |
| Affirm | form | PaymentIntentPaymentMethodDataAffirmOptions | No | |
| AfterpayClearpay | form | PaymentIntentPaymentMethodDataAfterpayClearpayOptions | No | |
| Alipay | form | PaymentIntentPaymentMethodDataAlipayOptions | No | |
| AllowRedisplay | form | string | No | |
| Alma | form | PaymentIntentPaymentMethodDataAlmaOptions | No | |
| AmazonPay | form | PaymentIntentPaymentMethodDataAmazonPayOptions | No | |
| AuBecsDebit | form | PaymentIntentPaymentMethodDataAuBecsDebitOptions | No | |
| BacsDebit | form | PaymentIntentPaymentMethodDataBacsDebitOptions | No | |
| Bancontact | form | PaymentIntentPaymentMethodDataBancontactOptions | No | |
| Billie | form | PaymentIntentPaymentMethodDataBillieOptions | No | |
| BillingDetails | form | PaymentIntentPaymentMethodDataBillingDetailsOptions | No | |
| Blik | form | PaymentIntentPaymentMethodDataBlikOptions | No | |
| Boleto | form | PaymentIntentPaymentMethodDataBoletoOptions | No | |
| Cashapp | form | PaymentIntentPaymentMethodDataCashappOptions | No | |
| CustomerBalance | form | PaymentIntentPaymentMethodDataCustomerBalanceOptions | No | |
| Eps | form | PaymentIntentPaymentMethodDataEpsOptions | No | |
| Fpx | form | PaymentIntentPaymentMethodDataFpxOptions | No | |
| Giropay | form | PaymentIntentPaymentMethodDataGiropayOptions | No | |
| Grabpay | form | PaymentIntentPaymentMethodDataGrabpayOptions | No | |
| Ideal | form | PaymentIntentPaymentMethodDataIdealOptions | No | |
| InteracPresent | form | PaymentIntentPaymentMethodDataInteracPresentOptions | No | |
| KakaoPay | form | PaymentIntentPaymentMethodDataKakaoPayOptions | No | |
| Klarna | form | PaymentIntentPaymentMethodDataKlarnaOptions | No | |
| Konbini | form | PaymentIntentPaymentMethodDataKonbiniOptions | No | |
| KrCard | form | PaymentIntentPaymentMethodDataKrCardOptions | No | |
| Link | form | PaymentIntentPaymentMethodDataLinkOptions | No | |
| Metadata | form | Dictionary<string, string> | No | |
| Mobilepay | form | PaymentIntentPaymentMethodDataMobilepayOptions | No | |
| Multibanco | form | PaymentIntentPaymentMethodDataMultibancoOptions | No | |
| NaverPay | form | PaymentIntentPaymentMethodDataNaverPayOptions | No | |
| NzBankAccount | form | PaymentIntentPaymentMethodDataNzBankAccountOptions | No | |
| Oxxo | form | PaymentIntentPaymentMethodDataOxxoOptions | No | |
| P24 | form | PaymentIntentPaymentMethodDataP24Options | No | |
| PayByBank | form | PaymentIntentPaymentMethodDataPayByBankOptions | No | |
| Payco | form | PaymentIntentPaymentMethodDataPaycoOptions | No | |
| Paynow | form | PaymentIntentPaymentMethodDataPaynowOptions | No | |
| Paypal | form | PaymentIntentPaymentMethodDataPaypalOptions | No | |
| Pix | form | PaymentIntentPaymentMethodDataPixOptions | No | |
| Promptpay | form | PaymentIntentPaymentMethodDataPromptpayOptions | No | |
| RadarOptions | form | PaymentIntentPaymentMethodDataRadarOptionsOptions | No | |
| RevolutPay | form | PaymentIntentPaymentMethodDataRevolutPayOptions | No | |
| SamsungPay | form | PaymentIntentPaymentMethodDataSamsungPayOptions | No | |
| Satispay | form | PaymentIntentPaymentMethodDataSatispayOptions | No | |
| SepaDebit | form | PaymentIntentPaymentMethodDataSepaDebitOptions | No | |
| Sofort | form | PaymentIntentPaymentMethodDataSofortOptions | No | |
| Swish | form | PaymentIntentPaymentMethodDataSwishOptions | No | |
| Twint | form | PaymentIntentPaymentMethodDataTwintOptions | No | |
| Type | form | string | No | |
| UsBankAccount | form | PaymentIntentPaymentMethodDataUsBankAccountOptions | No | |
| WechatPay | form | PaymentIntentPaymentMethodDataWechatPayOptions | No | |
| Zip | form | PaymentIntentPaymentMethodDataZipOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountNumber | form | string | No | |
| InstitutionNumber | form | string | No | |
| TransitNumber | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountNumber | form | string | No | |
| BsbNumber | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountNumber | form | string | No | |
| SortCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | AddressOptions | No | |
| form | string | No | ||
| Name | form | string | No | |
| Phone | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TaxId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Bank | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderType | form | string | No | |
| Bank | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Bank | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Dob | form | DobOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Day | form | long? | No | |
| Month | form | long? | No | |
| Year | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Funding | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderName | form | string | No | |
| AccountNumber | form | string | No | |
| BankCode | form | string | No | |
| BranchCode | form | string | No | |
| Reference | form | string | No | |
| Suffix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Bank | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Session | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Iban | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Country | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderType | form | string | No | |
| AccountNumber | form | string | No | |
| AccountType | form | string | No | |
| FinancialConnectionsAccount | form | string | No | |
| RoutingNumber | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcssDebit | form | PaymentIntentPaymentMethodOptionsAcssDebitOptions | No | |
| Affirm | form | PaymentIntentPaymentMethodOptionsAffirmOptions | No | |
| AfterpayClearpay | form | PaymentIntentPaymentMethodOptionsAfterpayClearpayOptions | No | |
| Alipay | form | PaymentIntentPaymentMethodOptionsAlipayOptions | No | |
| Alma | form | PaymentIntentPaymentMethodOptionsAlmaOptions | No | |
| AmazonPay | form | PaymentIntentPaymentMethodOptionsAmazonPayOptions | No | |
| AuBecsDebit | form | PaymentIntentPaymentMethodOptionsAuBecsDebitOptions | No | |
| BacsDebit | form | PaymentIntentPaymentMethodOptionsBacsDebitOptions | No | |
| Bancontact | form | PaymentIntentPaymentMethodOptionsBancontactOptions | No | |
| Blik | form | PaymentIntentPaymentMethodOptionsBlikOptions | No | |
| Boleto | form | PaymentIntentPaymentMethodOptionsBoletoOptions | No | |
| Card | form | PaymentIntentPaymentMethodOptionsCardOptions | No | |
| CardPresent | form | PaymentIntentPaymentMethodOptionsCardPresentOptions | No | |
| Cashapp | form | PaymentIntentPaymentMethodOptionsCashappOptions | No | |
| CustomerBalance | form | PaymentIntentPaymentMethodOptionsCustomerBalanceOptions | No | |
| Eps | form | PaymentIntentPaymentMethodOptionsEpsOptions | No | |
| Fpx | form | PaymentIntentPaymentMethodOptionsFpxOptions | No | |
| Giropay | form | PaymentIntentPaymentMethodOptionsGiropayOptions | No | |
| Grabpay | form | PaymentIntentPaymentMethodOptionsGrabpayOptions | No | |
| Ideal | form | PaymentIntentPaymentMethodOptionsIdealOptions | No | |
| InteracPresent | form | PaymentIntentPaymentMethodOptionsInteracPresentOptions | No | |
| KakaoPay | form | PaymentIntentPaymentMethodOptionsKakaoPayOptions | No | |
| Klarna | form | PaymentIntentPaymentMethodOptionsKlarnaOptions | No | |
| Konbini | form | PaymentIntentPaymentMethodOptionsKonbiniOptions | No | |
| KrCard | form | PaymentIntentPaymentMethodOptionsKrCardOptions | No | |
| Link | form | PaymentIntentPaymentMethodOptionsLinkOptions | No | |
| Mobilepay | form | PaymentIntentPaymentMethodOptionsMobilepayOptions | No | |
| Multibanco | form | PaymentIntentPaymentMethodOptionsMultibancoOptions | No | |
| NaverPay | form | PaymentIntentPaymentMethodOptionsNaverPayOptions | No | |
| NzBankAccount | form | PaymentIntentPaymentMethodOptionsNzBankAccountOptions | No | |
| Oxxo | form | PaymentIntentPaymentMethodOptionsOxxoOptions | No | |
| P24 | form | PaymentIntentPaymentMethodOptionsP24Options | No | |
| PayByBank | form | PaymentIntentPaymentMethodOptionsPayByBankOptions | No | |
| Payco | form | PaymentIntentPaymentMethodOptionsPaycoOptions | No | |
| Paynow | form | PaymentIntentPaymentMethodOptionsPaynowOptions | No | |
| Paypal | form | PaymentIntentPaymentMethodOptionsPaypalOptions | No | |
| Pix | form | PaymentIntentPaymentMethodOptionsPixOptions | No | |
| Promptpay | form | PaymentIntentPaymentMethodOptionsPromptpayOptions | No | |
| RevolutPay | form | PaymentIntentPaymentMethodOptionsRevolutPayOptions | No | |
| SamsungPay | form | PaymentIntentPaymentMethodOptionsSamsungPayOptions | No | |
| SepaDebit | form | PaymentIntentPaymentMethodOptionsSepaDebitOptions | No | |
| Sofort | form | PaymentIntentPaymentMethodOptionsSofortOptions | No | |
| Swish | form | PaymentIntentPaymentMethodOptionsSwishOptions | No | |
| Twint | form | PaymentIntentPaymentMethodOptionsTwintOptions | No | |
| UsBankAccount | form | PaymentIntentPaymentMethodOptionsUsBankAccountOptions | No | |
| WechatPay | form | PaymentIntentPaymentMethodOptionsWechatPayOptions | No | |
| Zip | form | PaymentIntentPaymentMethodOptionsZipOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | PaymentIntentPaymentMethodOptionsAcssDebitMandateOptionsOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No | |
| VerificationMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomMandateUrl | form | string | No | |
| IntervalDescription | form | string | No | |
| PaymentSchedule | form | string | No | |
| TransactionType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| PreferredLocale | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| Reference | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | PaymentIntentPaymentMethodOptionsBacsDebitMandateOptionsOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReferencePrefix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PreferredLanguage | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterDays | form | long? | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| CvcToken | form | string | No | |
| Installments | form | PaymentIntentPaymentMethodOptionsCardInstallmentsOptions | No | |
| MandateOptions | form | PaymentIntentPaymentMethodOptionsCardMandateOptionsOptions | No | |
| Moto | form | bool? | No | |
| Network | form | string | No | |
| RequestExtendedAuthorization | form | string | No | |
| RequestIncrementalAuthorization | form | string | No | |
| RequestMulticapture | form | string | No | |
| RequestOvercapture | form | string | No | |
| RequestThreeDSecure | form | string | No | |
| RequireCvcRecollection | form | bool? | No | |
| SetupFutureUsage | form | string | No | |
| StatementDescriptorSuffixKana | form | string | No | |
| StatementDescriptorSuffixKanji | form | string | No | |
| ThreeDSecure | form | PaymentIntentPaymentMethodOptionsCardThreeDSecureOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool? | No | |
| Plan | form | PaymentIntentPaymentMethodOptionsCardInstallmentsPlanOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Count | form | long? | No | |
| Interval | form | string | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long? | No | |
| AmountType | form | string | No | |
| Description | form | string | No | |
| EndDate | form | DateTime? | No | |
| Interval | form | string | No | |
| IntervalCount | form | long? | No | |
| Reference | form | string | No | |
| StartDate | form | DateTime? | No | |
| SupportedTypes | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AresTransStatus | form | string | No | |
| Cryptogram | form | string | No | |
| ElectronicCommerceIndicator | form | string | No | |
| ExemptionIndicator | form | string | No | |
| NetworkOptions | form | PaymentIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsOptions | No | |
| RequestorChallengeIndicator | form | string | No | |
| TransactionId | form | string | No | |
| Version | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CartesBancaires | form | PaymentIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CbAvalgo | form | string | No | |
| CbExemption | form | string | No | |
| CbScore | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RequestExtendedAuthorization | form | bool? | No | |
| RequestIncrementalAuthorizationSupport | form | bool? | No | |
| Routing | form | PaymentIntentPaymentMethodOptionsCardPresentRoutingOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RequestedPriority | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BankTransfer | form | PaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferOptions | No | |
| FundingType | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EuBankTransfer | form | PaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferOptions | No | |
| RequestedAddressTypes | form | List<string> | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Country | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| PreferredLocale | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConfirmationNumber | form | string | No | |
| ExpiresAfterDays | form | long? | No | |
| ExpiresAt | form | DateTime? | No | |
| ProductDescription | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| PersistentToken | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterDays | form | long? | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No | |
| TosShownAndAccepted | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| PreferredLocale | form | string | No | |
| Reference | form | string | No | |
| RiskCorrelationId | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterSeconds | form | long? | No | |
| ExpiresAt | form | DateTime? | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | PaymentIntentPaymentMethodOptionsSepaDebitMandateOptionsOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReferencePrefix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PreferredLanguage | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FinancialConnections | form | PaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsOptions | No | |
| MandateOptions | form | PaymentIntentPaymentMethodOptionsUsBankAccountMandateOptionsOptions | No | |
| Networks | form | PaymentIntentPaymentMethodOptionsUsBankAccountNetworksOptions | No | |
| PreferredSettlementSpeed | form | string | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No | |
| VerificationMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Filters | form | PaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersOptions | No | |
| Permissions | form | List<string> | No | |
| Prefetch | form | List<string> | No | |
| ReturnUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountSubcategories | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CollectionMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Requested | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AppId | form | string | No | |
| Client | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Session | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long? | No | |
| Destination | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | AddressOptions | No | |
| Balance | form | long? | No | |
| CashBalance | form | CustomerCashBalanceOptions | No | |
| Description | form | string | No | |
| form | string | No | ||
| InvoicePrefix | form | string | No | |
| InvoiceSettings | form | CustomerInvoiceSettingsOptions | No | |
| Metadata | form | Dictionary<string, string> | No | |
| Name | form | string | No | |
| NextInvoiceSequence | form | long? | No | |
| PaymentMethod | form | string | No | |
| Phone | form | string | No | |
| Plan | form | string | No | |
| PreferredLocales | form | List<string> | No | |
| Shipping | form | ShippingOptions | No | |
| Source | form | AnyOf<string, CardCreateNestedOptions> | No | |
| Tax | form | CustomerTaxOptions | No | |
| TaxExempt | form | string | No | |
| TaxIdData | form | List<CustomerTaxIdDataOptions> | No | |
| TestClock | form | string | No | |
| Validate | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Settings | form | CustomerCashBalanceSettingsOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReconciliationMode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomFields | form | List<CustomerInvoiceSettingsCustomFieldOptions> | No | |
| DefaultPaymentMethod | form | string | No | |
| Footer | form | string | No | |
| RenderingOptions | form | CustomerInvoiceSettingsRenderingOptionsOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmountTaxDisplay | form | string | No | |
| Template | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | AddressOptions | No | |
| Name | form | string | No | |
| Phone | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | Object | No | |
| Type | form | Type | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | Object | No | |
| Type | form | Type | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AddressCity | form | string | No | |
| AddressCountry | form | string | No | |
| AddressLine1 | form | string | No | |
| AddressLine2 | form | string | No | |
| AddressState | form | string | No | |
| AddressZip | form | string | No | |
| Currency | form | string | No | |
| Cvc | form | string | No | |
| ExpMonth | form | long? | No | |
| ExpYear | form | long? | No | |
| Metadata | form | Dictionary<string, string> | No | |
| Name | form | string | No | |
| Number | form | string | No | |
| Object | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IpAddress | form | string | No | |
| ValidateLocation | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | No | |
| IdempotencyKey | form | string | No | |
| StripeAccount | form | string | No | |
| StripeContext | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomSessionData | form | CustomSessionData | Yes | |
| CustomPaymentIntentData | form | CustomPaymentIntentData | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Session | form | Session | Yes | |
| LineItems | form | List<LineItem> | Yes | |
| PaymentIntent | form | PaymentIntent | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Object | form | string | No | |
| AdaptivePricing | form | SessionAdaptivePricing | No | |
| AfterExpiration | form | SessionAfterExpiration | No | |
| AllowPromotionCodes | form | bool? | No | |
| AmountSubtotal | form | long? | No | |
| AmountTotal | form | long? | No | |
| AutomaticTax | form | SessionAutomaticTax | No | |
| BillingAddressCollection | form | string | No | |
| CancelUrl | form | string | No | |
| ClientReferenceId | form | string | No | |
| ClientSecret | form | string | No | |
| CollectedInformation | form | SessionCollectedInformation | No | |
| Consent | form | SessionConsent | No | |
| ConsentCollection | form | SessionConsentCollection | No | |
| Created | form | DateTime | No | |
| Currency | form | string | No | |
| CurrencyConversion | form | SessionCurrencyConversion | No | |
| CustomFields | form | List<SessionCustomField> | No | |
| CustomText | form | SessionCustomText | No | |
| CustomerCreation | form | string | No | |
| CustomerDetails | form | SessionCustomerDetails | No | |
| CustomerEmail | form | string | No | |
| Discounts | form | List<SessionDiscount> | No | |
| ExpiresAt | form | DateTime | No | |
| InvoiceCreation | form | SessionInvoiceCreation | No | |
| LineItems | form | StripeList<LineItem> | No | |
| Livemode | form | bool | No | |
| Locale | form | string | No | |
| Metadata | form | Dictionary<string, string> | No | |
| Mode | form | string | No | |
| OptionalItems | form | List<SessionOptionalItem> | No | |
| PaymentMethodCollection | form | string | No | |
| PaymentMethodConfigurationDetails | form | SessionPaymentMethodConfigurationDetails | No | |
| PaymentMethodOptions | form | SessionPaymentMethodOptions | No | |
| PaymentMethodTypes | form | List<string> | No | |
| PaymentStatus | form | string | No | |
| Permissions | form | SessionPermissions | No | |
| PhoneNumberCollection | form | SessionPhoneNumberCollection | No | |
| PresentmentDetails | form | SessionPresentmentDetails | No | |
| RecoveredFrom | form | string | No | |
| RedirectOnCompletion | form | string | No | |
| ReturnUrl | form | string | No | |
| SavedPaymentMethodOptions | form | SessionSavedPaymentMethodOptions | No | |
| ShippingAddressCollection | form | SessionShippingAddressCollection | No | |
| ShippingCost | form | SessionShippingCost | No | |
| ShippingOptions | form | List<SessionShippingOption> | No | |
| Status | form | string | No | |
| SubmitType | form | string | No | |
| SuccessUrl | form | string | No | |
| TaxIdCollection | form | SessionTaxIdCollection | No | |
| TotalDetails | form | SessionTotalDetails | No | |
| UiMode | form | string | No | |
| Url | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Recovery | form | SessionAfterExpirationRecovery | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowPromotionCodes | form | bool | No | |
| Enabled | form | bool | No | |
| ExpiresAt | form | DateTime? | No | |
| Url | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool | No | |
| Liability | form | SessionAutomaticTaxLiability | No | |
| Status | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShippingDetails | form | SessionCollectedInformationShippingDetails | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | Address | No | |
| Name | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| City | form | string | No | |
| Country | form | string | No | |
| Line1 | form | string | No | |
| Line2 | form | string | No | |
| PostalCode | form | string | No | |
| State | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Promotions | form | string | No | |
| TermsOfService | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentMethodReuseAgreement | form | SessionConsentCollectionPaymentMethodReuseAgreement | No | |
| Promotions | form | string | No | |
| TermsOfService | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Position | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmountSubtotal | form | long | No | |
| AmountTotal | form | long | No | |
| FxRate | form | decimal | No | |
| SourceCurrency | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Dropdown | form | SessionCustomFieldDropdown | No | |
| Key | form | string | No | |
| Label | form | SessionCustomFieldLabel | No | |
| Numeric | form | SessionCustomFieldNumeric | No | |
| Optional | form | bool | No | |
| Text | form | SessionCustomFieldText | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DefaultValue | form | string | No | |
| Options | form | List<SessionCustomFieldDropdownOption> | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Custom | form | string | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DefaultValue | form | string | No | |
| MaximumLength | form | long? | No | |
| MinimumLength | form | long? | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DefaultValue | form | string | No | |
| MaximumLength | form | long? | No | |
| MinimumLength | form | long? | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AfterSubmit | form | SessionCustomTextAfterSubmit | No | |
| ShippingAddress | form | SessionCustomTextShippingAddress | No | |
| Submit | form | SessionCustomTextSubmit | No | |
| TermsOfServiceAcceptance | form | SessionCustomTextTermsOfServiceAcceptance | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | Address | No | |
| form | string | No | ||
| Name | form | string | No | |
| Phone | form | string | No | |
| TaxExempt | form | string | No | |
| TaxIds | form | List<SessionCustomerDetailsTaxId> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool | No | |
| InvoiceData | form | SessionInvoiceCreationInvoiceData | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomFields | form | List<SessionInvoiceCreationInvoiceDataCustomField> | No | |
| Description | form | string | No | |
| Footer | form | string | No | |
| Issuer | form | SessionInvoiceCreationInvoiceDataIssuer | No | |
| Metadata | form | Dictionary<string, string> | No | |
| RenderingOptions | form | SessionInvoiceCreationInvoiceDataRenderingOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmountTaxDisplay | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Object | form | string | No | |
| AmountDiscount | form | long | No | |
| AmountSubtotal | form | long | No | |
| AmountTax | form | long | No | |
| AmountTotal | form | long | No | |
| Currency | form | string | No | |
| Description | form | string | No | |
| Discounts | form | List<LineItemDiscount> | No | |
| Price | form | Price | No | |
| Quantity | form | long? | No | |
| Taxes | form | List<LineItemTax> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long | No | |
| Discount | form | Discount | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Object | form | string | No | |
| CheckoutSession | form | string | No | |
| Coupon | form | Coupon | No | |
| End | form | DateTime? | No | |
| Invoice | form | string | No | |
| InvoiceItem | form | string | No | |
| Start | form | DateTime | No | |
| Subscription | form | string | No | |
| SubscriptionItem | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Object | form | string | No | |
| AmountOff | form | long? | No | |
| AppliesTo | form | CouponAppliesTo | No | |
| Created | form | DateTime | No | |
| Currency | form | string | No | |
| CurrencyOptions | form | Dictionary<string, CouponCurrencyOptions> | No | |
| Duration | form | string | No | |
| DurationInMonths | form | long? | No | |
| Livemode | form | bool | No | |
| MaxRedemptions | form | long? | No | |
| Metadata | form | Dictionary<string, string> | No | |
| Name | form | string | No | |
| PercentOff | form | decimal? | No | |
| RedeemBy | form | DateTime? | No | |
| TimesRedeemed | form | long | No | |
| Valid | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Products | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmountOff | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Object | form | string | No | |
| Active | form | bool | No | |
| BillingScheme | form | string | No | |
| Created | form | DateTime | No | |
| Currency | form | string | No | |
| CurrencyOptions | form | Dictionary<string, PriceCurrencyOptions> | No | |
| CustomUnitAmount | form | PriceCustomUnitAmount | No | |
| Livemode | form | bool | No | |
| LookupKey | form | string | No | |
| Metadata | form | Dictionary<string, string> | No | |
| Nickname | form | string | No | |
| Recurring | form | PriceRecurring | No | |
| TaxBehavior | form | string | No | |
| Tiers | form | List<PriceTier> | No | |
| TiersMode | form | string | No | |
| TransformQuantity | form | PriceTransformQuantity | No | |
| Type | form | string | No | |
| UnitAmount | form | long? | No | |
| UnitAmountDecimal | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomUnitAmount | form | PriceCurrencyOptionsCustomUnitAmount | No | |
| TaxBehavior | form | string | No | |
| Tiers | form | List<PriceCurrencyOptionsTier> | No | |
| UnitAmount | form | long? | No | |
| UnitAmountDecimal | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Maximum | form | long? | No | |
| Minimum | form | long? | No | |
| Preset | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FlatAmount | form | long? | No | |
| FlatAmountDecimal | form | decimal? | No | |
| UnitAmount | form | long? | No | |
| UnitAmountDecimal | form | decimal? | No | |
| UpTo | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Maximum | form | long? | No | |
| Minimum | form | long? | No | |
| Preset | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Interval | form | string | No | |
| IntervalCount | form | long | No | |
| Meter | form | string | No | |
| TrialPeriodDays | form | long? | No | |
| UsageType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FlatAmount | form | long? | No | |
| FlatAmountDecimal | form | decimal? | No | |
| UnitAmount | form | long? | No | |
| UnitAmountDecimal | form | decimal? | No | |
| UpTo | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DivideBy | form | long | No | |
| Round | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long | No | |
| Rate | form | TaxRate | No | |
| TaxabilityReason | form | string | No | |
| TaxableAmount | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Object | form | string | No | |
| Active | form | bool | No | |
| Country | form | string | No | |
| Created | form | DateTime | No | |
| Description | form | string | No | |
| DisplayName | form | string | No | |
| EffectivePercentage | form | decimal? | No | |
| FlatAmount | form | TaxRateFlatAmount | No | |
| Inclusive | form | bool | No | |
| Jurisdiction | form | string | No | |
| JurisdictionLevel | form | string | No | |
| Livemode | form | bool | No | |
| Metadata | form | Dictionary<string, string> | No | |
| Percentage | form | decimal | No | |
| RateType | form | string | No | |
| State | form | string | No | |
| TaxType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long | No | |
| Currency | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AdjustableQuantity | form | SessionOptionalItemAdjustableQuantity | No | |
| Price | form | string | No | |
| Quantity | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool | No | |
| Maximum | form | long? | No | |
| Minimum | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Parent | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcssDebit | form | SessionPaymentMethodOptionsAcssDebit | No | |
| Affirm | form | SessionPaymentMethodOptionsAffirm | No | |
| AfterpayClearpay | form | SessionPaymentMethodOptionsAfterpayClearpay | No | |
| Alipay | form | SessionPaymentMethodOptionsAlipay | No | |
| AmazonPay | form | SessionPaymentMethodOptionsAmazonPay | No | |
| AuBecsDebit | form | SessionPaymentMethodOptionsAuBecsDebit | No | |
| BacsDebit | form | SessionPaymentMethodOptionsBacsDebit | No | |
| Bancontact | form | SessionPaymentMethodOptionsBancontact | No | |
| Boleto | form | SessionPaymentMethodOptionsBoleto | No | |
| Card | form | SessionPaymentMethodOptionsCard | No | |
| Cashapp | form | SessionPaymentMethodOptionsCashapp | No | |
| CustomerBalance | form | SessionPaymentMethodOptionsCustomerBalance | No | |
| Eps | form | SessionPaymentMethodOptionsEps | No | |
| Fpx | form | SessionPaymentMethodOptionsFpx | No | |
| Giropay | form | SessionPaymentMethodOptionsGiropay | No | |
| Grabpay | form | SessionPaymentMethodOptionsGrabpay | No | |
| Ideal | form | SessionPaymentMethodOptionsIdeal | No | |
| KakaoPay | form | SessionPaymentMethodOptionsKakaoPay | No | |
| Klarna | form | SessionPaymentMethodOptionsKlarna | No | |
| Konbini | form | SessionPaymentMethodOptionsKonbini | No | |
| KrCard | form | SessionPaymentMethodOptionsKrCard | No | |
| Link | form | SessionPaymentMethodOptionsLink | No | |
| Mobilepay | form | SessionPaymentMethodOptionsMobilepay | No | |
| Multibanco | form | SessionPaymentMethodOptionsMultibanco | No | |
| NaverPay | form | SessionPaymentMethodOptionsNaverPay | No | |
| Oxxo | form | SessionPaymentMethodOptionsOxxo | No | |
| P24 | form | SessionPaymentMethodOptionsP24 | No | |
| Payco | form | SessionPaymentMethodOptionsPayco | No | |
| Paynow | form | SessionPaymentMethodOptionsPaynow | No | |
| Paypal | form | SessionPaymentMethodOptionsPaypal | No | |
| Pix | form | SessionPaymentMethodOptionsPix | No | |
| RevolutPay | form | SessionPaymentMethodOptionsRevolutPay | No | |
| SamsungPay | form | SessionPaymentMethodOptionsSamsungPay | No | |
| SepaDebit | form | SessionPaymentMethodOptionsSepaDebit | No | |
| Sofort | form | SessionPaymentMethodOptionsSofort | No | |
| Swish | form | SessionPaymentMethodOptionsSwish | No | |
| UsBankAccount | form | SessionPaymentMethodOptionsUsBankAccount | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Currency | form | string | No | |
| MandateOptions | form | SessionPaymentMethodOptionsAcssDebitMandateOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No | |
| VerificationMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomMandateUrl | form | string | No | |
| DefaultFor | form | List<string> | No | |
| IntervalDescription | form | string | No | |
| PaymentSchedule | form | string | No | |
| TransactionType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | SessionPaymentMethodOptionsBacsDebitMandateOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReferencePrefix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterDays | form | long | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Installments | form | SessionPaymentMethodOptionsCardInstallments | No | |
| RequestExtendedAuthorization | form | string | No | |
| RequestIncrementalAuthorization | form | string | No | |
| RequestMulticapture | form | string | No | |
| RequestOvercapture | form | string | No | |
| RequestThreeDSecure | form | string | No | |
| Restrictions | form | SessionPaymentMethodOptionsCardRestrictions | No | |
| SetupFutureUsage | form | string | No | |
| StatementDescriptorSuffixKana | form | string | No | |
| StatementDescriptorSuffixKanji | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BrandsBlocked | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BankTransfer | form | SessionPaymentMethodOptionsCustomerBalanceBankTransfer | No | |
| FundingType | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EuBankTransfer | form | SessionPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer | No | |
| RequestedAddressTypes | form | List<string> | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Country | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterDays | form | long? | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterDays | form | long | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| PreferredLocale | form | string | No | |
| Reference | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterSeconds | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | SessionPaymentMethodOptionsSepaDebitMandateOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReferencePrefix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FinancialConnections | form | SessionPaymentMethodOptionsUsBankAccountFinancialConnections | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No | |
| VerificationMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Filters | form | SessionPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters | No | |
| Permissions | form | List<string> | No | |
| Prefetch | form | List<string> | No | |
| ReturnUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountSubcategories | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UpdateShippingDetails | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PresentmentAmount | form | long | No | |
| PresentmentCurrency | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowRedisplayFilters | form | List<string> | No | |
| PaymentMethodRemove | form | string | No | |
| PaymentMethodSave | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowedCountries | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmountSubtotal | form | long | No | |
| AmountTax | form | long | No | |
| AmountTotal | form | long | No | |
| Taxes | form | List<SessionShippingCostTax> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long | No | |
| Rate | form | TaxRate | No | |
| TaxabilityReason | form | string | No | |
| TaxableAmount | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShippingAmount | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool | No | |
| Required | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmountDiscount | form | long | No | |
| AmountShipping | form | long? | No | |
| AmountTax | form | long | No | |
| Breakdown | form | SessionTotalDetailsBreakdown | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Discounts | form | List<SessionTotalDetailsBreakdownDiscount> | No | |
| Taxes | form | List<SessionTotalDetailsBreakdownTax> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long | No | |
| Discount | form | Discount | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long | No | |
| Rate | form | TaxRate | No | |
| TaxabilityReason | form | string | No | |
| TaxableAmount | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Object | form | string | No | |
| Amount | form | long | No | |
| AmountCapturable | form | long | No | |
| AmountDetails | form | PaymentIntentAmountDetails | No | |
| AmountReceived | form | long | No | |
| ApplicationFeeAmount | form | long? | No | |
| AutomaticPaymentMethods | form | PaymentIntentAutomaticPaymentMethods | No | |
| CanceledAt | form | DateTime? | No | |
| CancellationReason | form | string | No | |
| CaptureMethod | form | string | No | |
| ClientSecret | form | string | No | |
| ConfirmationMethod | form | string | No | |
| Created | form | DateTime | No | |
| Currency | form | string | No | |
| Description | form | string | No | |
| LastPaymentError | form | StripeError | No | |
| Livemode | form | bool | No | |
| Metadata | form | Dictionary<string, string> | No | |
| NextAction | form | PaymentIntentNextAction | No | |
| PaymentMethodConfigurationDetails | form | PaymentIntentPaymentMethodConfigurationDetails | No | |
| PaymentMethodOptions | form | PaymentIntentPaymentMethodOptions | No | |
| PaymentMethodTypes | form | List<string> | No | |
| PresentmentDetails | form | PaymentIntentPresentmentDetails | No | |
| Processing | form | PaymentIntentProcessing | No | |
| ReceiptEmail | form | string | No | |
| SetupFutureUsage | form | string | No | |
| Shipping | form | Shipping | No | |
| StatementDescriptor | form | string | No | |
| StatementDescriptorSuffix | form | string | No | |
| Status | form | string | No | |
| TransferData | form | PaymentIntentTransferData | No | |
| TransferGroup | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Tip | form | PaymentIntentAmountDetailsTip | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowRedirects | form | string | No | |
| Enabled | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Charge | form | string | No | |
| Code | form | string | No | |
| DeclineCode | form | string | No | |
| DocUrl | form | string | No | |
| Message | form | string | No | |
| Param | form | string | No | |
| PaymentIntent | form | PaymentIntent | No | |
| PaymentMethod | form | PaymentMethod | No | |
| PaymentMethodType | form | string | No | |
| RequestLogUrl | form | string | No | |
| SetupIntent | form | SetupIntent | No | |
| Source | form | IPaymentSource | No | |
| Type | form | string | No | |
| Error | form | string | No | |
| ErrorDescription | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Object | form | string | No | |
| AcssDebit | form | PaymentMethodAcssDebit | No | |
| Affirm | form | PaymentMethodAffirm | No | |
| AfterpayClearpay | form | PaymentMethodAfterpayClearpay | No | |
| Alipay | form | PaymentMethodAlipay | No | |
| AllowRedisplay | form | string | No | |
| Alma | form | PaymentMethodAlma | No | |
| AmazonPay | form | PaymentMethodAmazonPay | No | |
| AuBecsDebit | form | PaymentMethodAuBecsDebit | No | |
| BacsDebit | form | PaymentMethodBacsDebit | No | |
| Bancontact | form | PaymentMethodBancontact | No | |
| Billie | form | PaymentMethodBillie | No | |
| BillingDetails | form | PaymentMethodBillingDetails | No | |
| Blik | form | PaymentMethodBlik | No | |
| Boleto | form | PaymentMethodBoleto | No | |
| Card | form | PaymentMethodCard | No | |
| CardPresent | form | PaymentMethodCardPresent | No | |
| Cashapp | form | PaymentMethodCashapp | No | |
| Created | form | DateTime | No | |
| CustomerBalance | form | PaymentMethodCustomerBalance | No | |
| Eps | form | PaymentMethodEps | No | |
| Fpx | form | PaymentMethodFpx | No | |
| Giropay | form | PaymentMethodGiropay | No | |
| Grabpay | form | PaymentMethodGrabpay | No | |
| Ideal | form | PaymentMethodIdeal | No | |
| InteracPresent | form | PaymentMethodInteracPresent | No | |
| KakaoPay | form | PaymentMethodKakaoPay | No | |
| Klarna | form | PaymentMethodKlarna | No | |
| Konbini | form | PaymentMethodKonbini | No | |
| KrCard | form | PaymentMethodKrCard | No | |
| Link | form | PaymentMethodLink | No | |
| Livemode | form | bool | No | |
| Metadata | form | Dictionary<string, string> | No | |
| Mobilepay | form | PaymentMethodMobilepay | No | |
| Multibanco | form | PaymentMethodMultibanco | No | |
| NaverPay | form | PaymentMethodNaverPay | No | |
| NzBankAccount | form | PaymentMethodNzBankAccount | No | |
| Oxxo | form | PaymentMethodOxxo | No | |
| P24 | form | PaymentMethodP24 | No | |
| PayByBank | form | PaymentMethodPayByBank | No | |
| Payco | form | PaymentMethodPayco | No | |
| Paynow | form | PaymentMethodPaynow | No | |
| Paypal | form | PaymentMethodPaypal | No | |
| Pix | form | PaymentMethodPix | No | |
| Promptpay | form | PaymentMethodPromptpay | No | |
| RadarOptions | form | PaymentMethodRadarOptions | No | |
| RevolutPay | form | PaymentMethodRevolutPay | No | |
| SamsungPay | form | PaymentMethodSamsungPay | No | |
| Satispay | form | PaymentMethodSatispay | No | |
| SepaDebit | form | PaymentMethodSepaDebit | No | |
| Sofort | form | PaymentMethodSofort | No | |
| Swish | form | PaymentMethodSwish | No | |
| Twint | form | PaymentMethodTwint | No | |
| Type | form | string | No | |
| UsBankAccount | form | PaymentMethodUsBankAccount | No | |
| WechatPay | form | PaymentMethodWechatPay | No | |
| Zip | form | PaymentMethodZip | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BankName | form | string | No | |
| Fingerprint | form | string | No | |
| InstitutionNumber | form | string | No | |
| Last4 | form | string | No | |
| TransitNumber | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BsbNumber | form | string | No | |
| Fingerprint | form | string | No | |
| Last4 | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Fingerprint | form | string | No | |
| Last4 | form | string | No | |
| SortCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | Address | No | |
| form | string | No | ||
| Name | form | string | No | |
| Phone | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TaxId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Brand | form | string | No | |
| Checks | form | PaymentMethodCardChecks | No | |
| Country | form | string | No | |
| Description | form | string | No | |
| DisplayBrand | form | string | No | |
| ExpMonth | form | long | No | |
| ExpYear | form | long | No | |
| Fingerprint | form | string | No | |
| Funding | form | string | No | |
| GeneratedFrom | form | PaymentMethodCardGeneratedFrom | No | |
| Iin | form | string | No | |
| Issuer | form | string | No | |
| Last4 | form | string | No | |
| Networks | form | PaymentMethodCardNetworks | No | |
| RegulatedStatus | form | string | No | |
| ThreeDSecureUsage | form | PaymentMethodCardThreeDSecureUsage | No | |
| Wallet | form | PaymentMethodCardWallet | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AddressLine1Check | form | string | No | |
| AddressPostalCodeCheck | form | string | No | |
| CvcCheck | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Charge | form | string | No | |
| PaymentMethodDetails | form | PaymentMethodCardGeneratedFromPaymentMethodDetails | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CardPresent | form | PaymentMethodCardGeneratedFromPaymentMethodDetailsCardPresent | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmountAuthorized | form | long? | No | |
| Brand | form | string | No | |
| BrandProduct | form | string | No | |
| CaptureBefore | form | DateTime | No | |
| CardholderName | form | string | No | |
| Country | form | string | No | |
| Description | form | string | No | |
| EmvAuthData | form | string | No | |
| ExpMonth | form | long | No | |
| ExpYear | form | long | No | |
| Fingerprint | form | string | No | |
| Funding | form | string | No | |
| GeneratedCard | form | string | No | |
| Iin | form | string | No | |
| IncrementalAuthorizationSupported | form | bool | No | |
| Issuer | form | string | No | |
| Last4 | form | string | No | |
| Network | form | string | No | |
| NetworkTransactionId | form | string | No | |
| Offline | form | PaymentMethodCardGeneratedFromPaymentMethodDetailsCardPresentOffline | No | |
| OvercaptureSupported | form | bool | No | |
| PreferredLocales | form | List<string> | No | |
| ReadMethod | form | string | No | |
| Receipt | form | PaymentMethodCardGeneratedFromPaymentMethodDetailsCardPresentReceipt | No | |
| Wallet | form | PaymentMethodCardGeneratedFromPaymentMethodDetailsCardPresentWallet | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StoredAt | form | DateTime? | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountType | form | string | No | |
| ApplicationCryptogram | form | string | No | |
| ApplicationPreferredName | form | string | No | |
| AuthorizationCode | form | string | No | |
| AuthorizationResponseCode | form | string | No | |
| CardholderVerificationMethod | form | string | No | |
| DedicatedFileName | form | string | No | |
| TerminalVerificationResults | form | string | No | |
| TransactionStatusInformation | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Available | form | List<string> | No | |
| Preferred | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Supported | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmexExpressCheckout | form | PaymentMethodCardWalletAmexExpressCheckout | No | |
| ApplePay | form | PaymentMethodCardWalletApplePay | No | |
| DynamicLast4 | form | string | No | |
| GooglePay | form | PaymentMethodCardWalletGooglePay | No | |
| Link | form | PaymentMethodCardWalletLink | No | |
| Masterpass | form | PaymentMethodCardWalletMasterpass | No | |
| SamsungPay | form | PaymentMethodCardWalletSamsungPay | No | |
| Type | form | string | No | |
| VisaCheckout | form | PaymentMethodCardWalletVisaCheckout | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BillingAddress | form | Address | No | |
| form | string | No | ||
| Name | form | string | No | |
| ShippingAddress | form | Address | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BillingAddress | form | Address | No | |
| form | string | No | ||
| Name | form | string | No | |
| ShippingAddress | form | Address | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Brand | form | string | No | |
| BrandProduct | form | string | No | |
| CardholderName | form | string | No | |
| Country | form | string | No | |
| Description | form | string | No | |
| ExpMonth | form | long | No | |
| ExpYear | form | long | No | |
| Fingerprint | form | string | No | |
| Funding | form | string | No | |
| Iin | form | string | No | |
| Issuer | form | string | No | |
| Last4 | form | string | No | |
| Networks | form | PaymentMethodCardPresentNetworks | No | |
| Offline | form | PaymentMethodCardPresentOffline | No | |
| PreferredLocales | form | List<string> | No | |
| ReadMethod | form | string | No | |
| Wallet | form | PaymentMethodCardPresentWallet | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Available | form | List<string> | No | |
| Preferred | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StoredAt | form | DateTime? | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BuyerId | form | string | No | |
| Cashtag | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Bank | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderType | form | string | No | |
| Bank | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Bank | form | string | No | |
| Bic | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Brand | form | string | No | |
| CardholderName | form | string | No | |
| Country | form | string | No | |
| Description | form | string | No | |
| ExpMonth | form | long | No | |
| ExpYear | form | long | No | |
| Fingerprint | form | string | No | |
| Funding | form | string | No | |
| Iin | form | string | No | |
| Issuer | form | string | No | |
| Last4 | form | string | No | |
| Networks | form | PaymentMethodInteracPresentNetworks | No | |
| PreferredLocales | form | List<string> | No | |
| ReadMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Available | form | List<string> | No | |
| Preferred | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Dob | form | PaymentMethodKlarnaDob | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Day | form | long? | No | |
| Month | form | long? | No | |
| Year | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Brand | form | string | No | |
| Last4 | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| form | string | No | ||
| PersistentToken | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BuyerId | form | string | No | |
| Funding | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderName | form | string | No | |
| BankCode | form | string | No | |
| BankName | form | string | No | |
| BranchCode | form | string | No | |
| Last4 | form | string | No | |
| Suffix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Bank | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Country | form | string | No | |
| PayerEmail | form | string | No | |
| PayerId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Session | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BankCode | form | string | No | |
| BranchCode | form | string | No | |
| Country | form | string | No | |
| Fingerprint | form | string | No | |
| GeneratedFrom | form | PaymentMethodSepaDebitGeneratedFrom | No | |
| Last4 | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Country | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderType | form | string | No | |
| AccountType | form | string | No | |
| BankName | form | string | No | |
| FinancialConnectionsAccount | form | string | No | |
| Fingerprint | form | string | No | |
| Last4 | form | string | No | |
| Networks | form | PaymentMethodUsBankAccountNetworks | No | |
| RoutingNumber | form | string | No | |
| StatusDetails | form | PaymentMethodUsBankAccountStatusDetails | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Preferred | form | string | No | |
| Supported | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Blocked | form | PaymentMethodUsBankAccountStatusDetailsBlocked | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NetworkCode | form | string | No | |
| Reason | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Object | form | string | No | |
| AttachToSelf | form | bool | No | |
| AutomaticPaymentMethods | form | SetupIntentAutomaticPaymentMethods | No | |
| CancellationReason | form | string | No | |
| ClientSecret | form | string | No | |
| Created | form | DateTime | No | |
| Description | form | string | No | |
| FlowDirections | form | List<string> | No | |
| LastSetupError | form | StripeError | No | |
| Livemode | form | bool | No | |
| Metadata | form | Dictionary<string, string> | No | |
| NextAction | form | SetupIntentNextAction | No | |
| PaymentMethodConfigurationDetails | form | SetupIntentPaymentMethodConfigurationDetails | No | |
| PaymentMethodOptions | form | SetupIntentPaymentMethodOptions | No | |
| PaymentMethodTypes | form | List<string> | No | |
| Status | form | string | No | |
| Usage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllowRedirects | form | string | No | |
| Enabled | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CashappHandleRedirectOrDisplayQrCode | form | SetupIntentNextActionCashappHandleRedirectOrDisplayQrCode | No | |
| RedirectToUrl | form | SetupIntentNextActionRedirectToUrl | No | |
| Type | form | string | No | |
| UseStripeSdk | form | SetupIntentNextActionUseStripeSdk | No | |
| VerifyWithMicrodeposits | form | SetupIntentNextActionVerifyWithMicrodeposits | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HostedInstructionsUrl | form | string | No | |
| MobileAuthUrl | form | string | No | |
| QrCode | form | SetupIntentNextActionCashappHandleRedirectOrDisplayQrCodeQrCode | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAt | form | DateTime | No | |
| ImageUrlPng | form | string | No | |
| ImageUrlSvg | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReturnUrl | form | string | No | |
| Url | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ArrivalDate | form | DateTime | No | |
| HostedVerificationUrl | form | string | No | |
| MicrodepositType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Parent | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcssDebit | form | SetupIntentPaymentMethodOptionsAcssDebit | No | |
| AmazonPay | form | SetupIntentPaymentMethodOptionsAmazonPay | No | |
| BacsDebit | form | SetupIntentPaymentMethodOptionsBacsDebit | No | |
| Card | form | SetupIntentPaymentMethodOptionsCard | No | |
| CardPresent | form | SetupIntentPaymentMethodOptionsCardPresent | No | |
| Link | form | SetupIntentPaymentMethodOptionsLink | No | |
| Paypal | form | SetupIntentPaymentMethodOptionsPaypal | No | |
| SepaDebit | form | SetupIntentPaymentMethodOptionsSepaDebit | No | |
| UsBankAccount | form | SetupIntentPaymentMethodOptionsUsBankAccount | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Currency | form | string | No | |
| MandateOptions | form | SetupIntentPaymentMethodOptionsAcssDebitMandateOptions | No | |
| VerificationMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomMandateUrl | form | string | No | |
| DefaultFor | form | List<string> | No | |
| IntervalDescription | form | string | No | |
| PaymentSchedule | form | string | No | |
| TransactionType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | SetupIntentPaymentMethodOptionsBacsDebitMandateOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReferencePrefix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | SetupIntentPaymentMethodOptionsCardMandateOptions | No | |
| Network | form | string | No | |
| RequestThreeDSecure | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long | No | |
| AmountType | form | string | No | |
| Currency | form | string | No | |
| Description | form | string | No | |
| EndDate | form | DateTime? | No | |
| Interval | form | string | No | |
| IntervalCount | form | long? | No | |
| Reference | form | string | No | |
| StartDate | form | DateTime | No | |
| SupportedTypes | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PersistentToken | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BillingAgreementId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | SetupIntentPaymentMethodOptionsSepaDebitMandateOptions | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReferencePrefix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FinancialConnections | form | SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnections | No | |
| MandateOptions | form | SetupIntentPaymentMethodOptionsUsBankAccountMandateOptions | No | |
| VerificationMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Filters | form | SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters | No | |
| Permissions | form | List<string> | No | |
| Prefetch | form | List<string> | No | |
| ReturnUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountSubcategories | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CollectionMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AlipayHandleRedirect | form | PaymentIntentNextActionAlipayHandleRedirect | No | |
| BoletoDisplayDetails | form | PaymentIntentNextActionBoletoDisplayDetails | No | |
| CardAwaitNotification | form | PaymentIntentNextActionCardAwaitNotification | No | |
| CashappHandleRedirectOrDisplayQrCode | form | PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode | No | |
| DisplayBankTransferInstructions | form | PaymentIntentNextActionDisplayBankTransferInstructions | No | |
| KonbiniDisplayDetails | form | PaymentIntentNextActionKonbiniDisplayDetails | No | |
| MultibancoDisplayDetails | form | PaymentIntentNextActionMultibancoDisplayDetails | No | |
| OxxoDisplayDetails | form | PaymentIntentNextActionOxxoDisplayDetails | No | |
| PaynowDisplayQrCode | form | PaymentIntentNextActionPaynowDisplayQrCode | No | |
| PixDisplayQrCode | form | PaymentIntentNextActionPixDisplayQrCode | No | |
| PromptpayDisplayQrCode | form | PaymentIntentNextActionPromptpayDisplayQrCode | No | |
| RedirectToUrl | form | PaymentIntentNextActionRedirectToUrl | No | |
| SwishHandleRedirectOrDisplayQrCode | form | PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode | No | |
| Type | form | string | No | |
| UseStripeSdk | form | PaymentIntentNextActionUseStripeSdk | No | |
| VerifyWithMicrodeposits | form | PaymentIntentNextActionVerifyWithMicrodeposits | No | |
| WechatPayDisplayQrCode | form | PaymentIntentNextActionWechatPayDisplayQrCode | No | |
| WechatPayRedirectToAndroidApp | form | PaymentIntentNextActionWechatPayRedirectToAndroidApp | No | |
| WechatPayRedirectToIosApp | form | PaymentIntentNextActionWechatPayRedirectToIosApp | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NativeData | form | string | No | |
| NativeUrl | form | string | No | |
| ReturnUrl | form | string | No | |
| Url | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAt | form | DateTime? | No | |
| HostedVoucherUrl | form | string | No | |
| Number | form | string | No | |
| form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ChargeAttemptAt | form | DateTime? | No | |
| CustomerApprovalRequired | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HostedInstructionsUrl | form | string | No | |
| MobileAuthUrl | form | string | No | |
| QrCode | form | PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCodeQrCode | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAt | form | DateTime | No | |
| ImageUrlPng | form | string | No | |
| ImageUrlSvg | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmountRemaining | form | long? | No | |
| Currency | form | string | No | |
| FinancialAddresses | form | List<PaymentIntentNextActionDisplayBankTransferInstructionsFinancialAddress> | No | |
| HostedInstructionsUrl | form | string | No | |
| Reference | form | string | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Aba | form | PaymentIntentNextActionDisplayBankTransferInstructionsFinancialAddressAba | No | |
| Iban | form | PaymentIntentNextActionDisplayBankTransferInstructionsFinancialAddressIban | No | |
| SortCode | form | PaymentIntentNextActionDisplayBankTransferInstructionsFinancialAddressSortCode | No | |
| Spei | form | PaymentIntentNextActionDisplayBankTransferInstructionsFinancialAddressSpei | No | |
| SupportedNetworks | form | List<string> | No | |
| Swift | form | PaymentIntentNextActionDisplayBankTransferInstructionsFinancialAddressSwift | No | |
| Type | form | string | No | |
| Zengin | form | PaymentIntentNextActionDisplayBankTransferInstructionsFinancialAddressZengin | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderAddress | form | Address | No | |
| AccountHolderName | form | string | No | |
| AccountNumber | form | string | No | |
| AccountType | form | string | No | |
| BankAddress | form | Address | No | |
| BankName | form | string | No | |
| RoutingNumber | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderAddress | form | Address | No | |
| AccountHolderName | form | string | No | |
| BankAddress | form | Address | No | |
| Bic | form | string | No | |
| Country | form | string | No | |
| Iban | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderAddress | form | Address | No | |
| AccountHolderName | form | string | No | |
| AccountNumber | form | string | No | |
| BankAddress | form | Address | No | |
| SortCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderAddress | form | Address | No | |
| AccountHolderName | form | string | No | |
| BankAddress | form | Address | No | |
| BankCode | form | string | No | |
| BankName | form | string | No | |
| Clabe | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderAddress | form | Address | No | |
| AccountHolderName | form | string | No | |
| AccountNumber | form | string | No | |
| AccountType | form | string | No | |
| BankAddress | form | Address | No | |
| BankName | form | string | No | |
| SwiftCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderAddress | form | Address | No | |
| AccountHolderName | form | string | No | |
| AccountNumber | form | string | No | |
| AccountType | form | string | No | |
| BankAddress | form | Address | No | |
| BankCode | form | string | No | |
| BankName | form | string | No | |
| BranchCode | form | string | No | |
| BranchName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAt | form | DateTime | No | |
| HostedVoucherUrl | form | string | No | |
| Stores | form | PaymentIntentNextActionKonbiniDisplayDetailsStores | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Familymart | form | PaymentIntentNextActionKonbiniDisplayDetailsStoresFamilymart | No | |
| Lawson | form | PaymentIntentNextActionKonbiniDisplayDetailsStoresLawson | No | |
| Ministop | form | PaymentIntentNextActionKonbiniDisplayDetailsStoresMinistop | No | |
| Seicomart | form | PaymentIntentNextActionKonbiniDisplayDetailsStoresSeicomart | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConfirmationNumber | form | string | No | |
| PaymentCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConfirmationNumber | form | string | No | |
| PaymentCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConfirmationNumber | form | string | No | |
| PaymentCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConfirmationNumber | form | string | No | |
| PaymentCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Entity | form | string | No | |
| ExpiresAt | form | DateTime? | No | |
| HostedVoucherUrl | form | string | No | |
| Reference | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfter | form | DateTime? | No | |
| HostedVoucherUrl | form | string | No | |
| Number | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | string | No | |
| HostedInstructionsUrl | form | string | No | |
| ImageUrlPng | form | string | No | |
| ImageUrlSvg | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | string | No | |
| ExpiresAt | form | DateTime | No | |
| HostedInstructionsUrl | form | string | No | |
| ImageUrlPng | form | string | No | |
| ImageUrlSvg | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | string | No | |
| HostedInstructionsUrl | form | string | No | |
| ImageUrlPng | form | string | No | |
| ImageUrlSvg | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReturnUrl | form | string | No | |
| Url | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HostedInstructionsUrl | form | string | No | |
| MobileAuthUrl | form | string | No | |
| QrCode | form | PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCodeQrCode | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | string | No | |
| ImageUrlPng | form | string | No | |
| ImageUrlSvg | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ArrivalDate | form | DateTime | No | |
| HostedVerificationUrl | form | string | No | |
| MicrodepositType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | string | No | |
| HostedInstructionsUrl | form | string | No | |
| ImageDataUrl | form | string | No | |
| ImageUrlPng | form | string | No | |
| ImageUrlSvg | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AppId | form | string | No | |
| NonceStr | form | string | No | |
| Package | form | string | No | |
| PartnerId | form | string | No | |
| PrepayId | form | string | No | |
| Sign | form | string | No | |
| Timestamp | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NativeUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Parent | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcssDebit | form | PaymentIntentPaymentMethodOptionsAcssDebit | No | |
| Affirm | form | PaymentIntentPaymentMethodOptionsAffirm | No | |
| AfterpayClearpay | form | PaymentIntentPaymentMethodOptionsAfterpayClearpay | No | |
| Alipay | form | PaymentIntentPaymentMethodOptionsAlipay | No | |
| Alma | form | PaymentIntentPaymentMethodOptionsAlma | No | |
| AmazonPay | form | PaymentIntentPaymentMethodOptionsAmazonPay | No | |
| AuBecsDebit | form | PaymentIntentPaymentMethodOptionsAuBecsDebit | No | |
| BacsDebit | form | PaymentIntentPaymentMethodOptionsBacsDebit | No | |
| Bancontact | form | PaymentIntentPaymentMethodOptionsBancontact | No | |
| Blik | form | PaymentIntentPaymentMethodOptionsBlik | No | |
| Boleto | form | PaymentIntentPaymentMethodOptionsBoleto | No | |
| Card | form | PaymentIntentPaymentMethodOptionsCard | No | |
| CardPresent | form | PaymentIntentPaymentMethodOptionsCardPresent | No | |
| Cashapp | form | PaymentIntentPaymentMethodOptionsCashapp | No | |
| CustomerBalance | form | PaymentIntentPaymentMethodOptionsCustomerBalance | No | |
| Eps | form | PaymentIntentPaymentMethodOptionsEps | No | |
| Fpx | form | PaymentIntentPaymentMethodOptionsFpx | No | |
| Giropay | form | PaymentIntentPaymentMethodOptionsGiropay | No | |
| Grabpay | form | PaymentIntentPaymentMethodOptionsGrabpay | No | |
| Ideal | form | PaymentIntentPaymentMethodOptionsIdeal | No | |
| InteracPresent | form | PaymentIntentPaymentMethodOptionsInteracPresent | No | |
| KakaoPay | form | PaymentIntentPaymentMethodOptionsKakaoPay | No | |
| Klarna | form | PaymentIntentPaymentMethodOptionsKlarna | No | |
| Konbini | form | PaymentIntentPaymentMethodOptionsKonbini | No | |
| KrCard | form | PaymentIntentPaymentMethodOptionsKrCard | No | |
| Link | form | PaymentIntentPaymentMethodOptionsLink | No | |
| Mobilepay | form | PaymentIntentPaymentMethodOptionsMobilepay | No | |
| Multibanco | form | PaymentIntentPaymentMethodOptionsMultibanco | No | |
| NaverPay | form | PaymentIntentPaymentMethodOptionsNaverPay | No | |
| NzBankAccount | form | PaymentIntentPaymentMethodOptionsNzBankAccount | No | |
| Oxxo | form | PaymentIntentPaymentMethodOptionsOxxo | No | |
| P24 | form | PaymentIntentPaymentMethodOptionsP24 | No | |
| PayByBank | form | PaymentIntentPaymentMethodOptionsPayByBank | No | |
| Payco | form | PaymentIntentPaymentMethodOptionsPayco | No | |
| Paynow | form | PaymentIntentPaymentMethodOptionsPaynow | No | |
| Paypal | form | PaymentIntentPaymentMethodOptionsPaypal | No | |
| Pix | form | PaymentIntentPaymentMethodOptionsPix | No | |
| Promptpay | form | PaymentIntentPaymentMethodOptionsPromptpay | No | |
| RevolutPay | form | PaymentIntentPaymentMethodOptionsRevolutPay | No | |
| SamsungPay | form | PaymentIntentPaymentMethodOptionsSamsungPay | No | |
| SepaDebit | form | PaymentIntentPaymentMethodOptionsSepaDebit | No | |
| Sofort | form | PaymentIntentPaymentMethodOptionsSofort | No | |
| Swish | form | PaymentIntentPaymentMethodOptionsSwish | No | |
| Twint | form | PaymentIntentPaymentMethodOptionsTwint | No | |
| UsBankAccount | form | PaymentIntentPaymentMethodOptionsUsBankAccount | No | |
| WechatPay | form | PaymentIntentPaymentMethodOptionsWechatPay | No | |
| Zip | form | PaymentIntentPaymentMethodOptionsZip | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | PaymentIntentPaymentMethodOptionsAcssDebitMandateOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No | |
| VerificationMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomMandateUrl | form | string | No | |
| IntervalDescription | form | string | No | |
| PaymentSchedule | form | string | No | |
| TransactionType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| PreferredLocale | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| Reference | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | PaymentIntentPaymentMethodOptionsBacsDebitMandateOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReferencePrefix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PreferredLanguage | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterDays | form | long | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| Installments | form | PaymentIntentPaymentMethodOptionsCardInstallments | No | |
| MandateOptions | form | PaymentIntentPaymentMethodOptionsCardMandateOptions | No | |
| Network | form | string | No | |
| RequestExtendedAuthorization | form | string | No | |
| RequestIncrementalAuthorization | form | string | No | |
| RequestMulticapture | form | string | No | |
| RequestOvercapture | form | string | No | |
| RequestThreeDSecure | form | string | No | |
| RequireCvcRecollection | form | bool | No | |
| SetupFutureUsage | form | string | No | |
| StatementDescriptorSuffixKana | form | string | No | |
| StatementDescriptorSuffixKanji | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AvailablePlans | form | List<PaymentIntentPaymentMethodOptionsCardInstallmentsPlan> | No | |
| Enabled | form | bool | No | |
| Plan | form | PaymentIntentPaymentMethodOptionsCardInstallmentsPlan | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Count | form | long? | No | |
| Interval | form | string | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long | No | |
| AmountType | form | string | No | |
| Description | form | string | No | |
| EndDate | form | DateTime? | No | |
| Interval | form | string | No | |
| IntervalCount | form | long? | No | |
| Reference | form | string | No | |
| StartDate | form | DateTime | No | |
| SupportedTypes | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RequestExtendedAuthorization | form | bool? | No | |
| RequestIncrementalAuthorizationSupport | form | bool? | No | |
| Routing | form | PaymentIntentPaymentMethodOptionsCardPresentRouting | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RequestedPriority | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BankTransfer | form | PaymentIntentPaymentMethodOptionsCustomerBalanceBankTransfer | No | |
| FundingType | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EuBankTransfer | form | PaymentIntentPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer | No | |
| RequestedAddressTypes | form | List<string> | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Country | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| PreferredLocale | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConfirmationNumber | form | string | No | |
| ExpiresAfterDays | form | long? | No | |
| ExpiresAt | form | DateTime? | No | |
| ProductDescription | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| PersistentToken | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterDays | form | long | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| PreferredLocale | form | string | No | |
| Reference | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExpiresAfterSeconds | form | long? | No | |
| ExpiresAt | form | DateTime? | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CaptureMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MandateOptions | form | PaymentIntentPaymentMethodOptionsSepaDebitMandateOptions | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReferencePrefix | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PreferredLanguage | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Reference | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FinancialConnections | form | PaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnections | No | |
| MandateOptions | form | PaymentIntentPaymentMethodOptionsUsBankAccountMandateOptions | No | |
| PreferredSettlementSpeed | form | string | No | |
| SetupFutureUsage | form | string | No | |
| TargetDate | form | string | No | |
| VerificationMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Filters | form | PaymentIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters | No | |
| Permissions | form | List<string> | No | |
| Prefetch | form | List<string> | No | |
| ReturnUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountSubcategories | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CollectionMethod | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AppId | form | string | No | |
| Client | form | string | No | |
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SetupFutureUsage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PresentmentAmount | form | long | No | |
| PresentmentCurrency | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Card | form | PaymentIntentProcessingCard | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerNotification | form | PaymentIntentProcessingCardCustomerNotification | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApprovalRequested | form | bool? | No | |
| CompletesAt | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | Address | No | |
| Carrier | form | string | No | |
| Name | form | string | No | |
| Phone | form | string | No | |
| TrackingNumber | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentIntent | form | PaymentIntent | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Dist | form | DataCacheStore | Yes | |
| Static | form | DataCacheStore | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurrencyId | form | string | Yes | |
| CurrencyInfo | form | Currency | Yes | |
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| InternalReferenceId | form | string | Yes | |
| ArticleTypeId | form | int | Yes | |
| PaymentReferenceId | form | string | No | |
| PaymentProviderId | form | int? | No | |
| OrderItemReferenceId | form | string | No | |
| Amount | form | double? | No | |
| VAT | form | decimal? | No | |
| AmountCredited | form | double? | No | |
| Comments | form | string | No | |
| Created | form | DateTime | Yes | |
| Updated | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ArticleTypeId | form | int | No | |
| ArticleTypeName | form | string | Yes | |
| ArticleTypeDescription | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Company | form | Company | Yes | |
| CurrencyInfo | form | Currency | Yes | |
| ArticleServiceRelations | form | List<ArticleServiceRelation> | Yes | |
| ServiceIds | form | List<int> | Yes | |
| Services | form | List<Service> | Yes | |
| ArticleType | form | ArticleTypeEnum | No | |
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| Name | form | string | Yes | |
| ArticleTypeId | form | int | Yes | |
| Description | form | string | No | |
| ImageUrl | form | string | No | |
| Active | form | bool | Yes | |
| Amount | form | int | Yes | |
| Price | form | double | Yes | |
| VAT | form | decimal? | No | |
| CurrencyId | form | string | Yes | |
| UpdatedDate | form | DateTime | Yes | |
| CreatedDate | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| ServiceId | form | int | Yes | |
| ArticleId | form | int | Yes |
| Name | Value | |
|---|---|---|
| ServiceArticle | 1 | |
| StandAloneArticle | 2 | |
| RebateCodePunchTicketArticle | 3 | |
| RebateCodeGiftCardArticle | 4 | |
| RebateCodeValueCardArticle | 5 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ArticleInvoiceAddressId | form | Guid | Yes | |
| CompanyId | form | Guid | Yes | |
| InternalReferenceId | form | string | Yes | |
| ArticleTypeId | form | int | Yes | |
| CorporateIdentityNumber | form | string | No | |
| InvoiceAddress1 | form | string | No | |
| InvoiceAddress2 | form | string | No | |
| InvoiceCity | form | string | No | |
| InvoicePostalCode | form | string | No | |
| InvoiceCountryCode | form | string | No | |
| UpdatedDate | form | DateTime | Yes | |
| CreatedDate | form | DateTime | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DayOfWeek | form | BokaMeraDayOfWeek | No | |
| DayOfWeekId | form | int | Yes | |
| RebateCodeId | form | int | Yes | |
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | Yes | |
| ServiceId | form | int | Yes | |
| RebateCodeId | form | int | Yes | |
| Id | form | int | No | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | Yes | |
| PriceId | form | int | Yes | |
| RebateCodeId | form | int | Yes | |
| Id | form | int | No | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | Yes | |
| CustomerId | form | Guid | Yes | |
| RebateCodeId | form | int | Yes | |
| Id | form | int | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| RebateCodeEmailSentToCustomer | form | bool | No | |
| MessageToReceiver | form | string | No | |
| Buyer | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DayOfWeek | form | string | Yes | |
| DayOfWeekTranslation | form | string | Yes | |
| DayOfWeekActive | form | bool? | No | |
| DayOfWeekSortOrder | form | short? | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Booking | form | Booking | Yes | |
| RebateCode | form | RebateCode | Yes | |
| Customer | form | Customer | Yes | |
| Id | form | int | No | |
| CompanyId | form | Guid | No | |
| Note | form | string | No | |
| RebateCodeId | form | int | Yes | |
| Amount | form | double | Yes | |
| Usage | form | int | Yes | |
| BookingId | form | int? | No | |
| UpdatedDate | form | DateTime | Yes | |
| CreatedDate | form | DateTime | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Service | form | Service | Yes | |
| Log | form | List<BookingLog> | Yes | |
| CheckoutLogs | form | List<PaymentDetails> | Yes | |
| Prices | form | List<BookingPrice> | Yes | |
| Status | form | BookingStatusEnum | No | |
| IsReserved | form | bool | No | |
| StatusName | form | string | Yes | |
| BookingStatus | form | BookingStatus | Yes | |
| TotalPrice | form | double? | No | |
| TotalSpots | form | int? | No | |
| Resources | form | IList<Resource> | Yes | |
| ExternalReferences | form | IList<ExternalReference> | Yes | |
| BookedResources | form | IList<BookedResourceType> | Yes | |
| CustomFieldsConfig | form | IList<CustomFieldConfig> | Yes | |
| CustomFieldsData | form | IList<CustomFieldDataResponse> | Yes | |
| DeterministicId | form | Guid | No | |
| Active | form | bool | No | |
| LastTimeToUnBook | form | DateTime? | No | |
| PriceMappings | form | List<PriceMapping> | Yes | |
| InternalReferenceId | form | string | Yes | |
| Id | form | int | No | |
| CustomerId | form | Guid | Yes | |
| ServiceId | form | int | Yes | |
| StatusId | form | int | Yes | |
| UnbookedOn | form | DateTime? | No | |
| UnbookedComments | form | string | No | |
| BookedComments | form | string | No | |
| BookedBy | form | string | Yes | |
| UnBookedBy | form | string | No | |
| SendSmsReminder | form | bool | Yes | |
| SendEmailReminder | form | bool | Yes | |
| SendSmsConfirmation | form | bool | Yes | |
| RebateCode | form | string | No | |
| Comments | form | string | No | |
| IpAddress | form | string | No | |
| NumberOfBookedSpots | form | int | Yes | |
| CommentsToCustomer | form | string | No | |
| PaymentExpiration | form | DateTime? | No | |
| SendEmailConfirmation | form | bool | Yes | |
| CancellationCode | form | string | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| RatingCode | form | string | No | |
| TextField1 | form | string | No | |
| TextField2 | form | string | No | |
| TextField3 | form | string | No | |
| TextField4 | form | string | No | |
| TextField5 | form | string | No | |
| TextField6 | form | string | No | |
| TextField7 | form | string | No | |
| TextField8 | form | string | No | |
| TextField9 | form | string | No | |
| TextField10 | form | string | No | |
| TextField11 | form | string | No | |
| TextField12 | form | string | No | |
| TextField13 | form | string | No | |
| TextField14 | form | string | No | |
| TextField15 | form | string | No | |
| TextField16 | form | string | No | |
| TextField17 | form | string | No | |
| TextField18 | form | string | No | |
| TextField19 | form | string | No | |
| TextField20 | form | string | No | |
| From | form | DateTime | Yes | |
| To | form | DateTime | Yes | |
| ArticleInvoiceAddressId | form | Guid? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EventTypeId | form | int | No | |
| EventType | form | BookingLogEventType | Yes | |
| CompanyId | form | Guid | Yes | |
| BookingId | form | int | Yes | |
| Id | form | int | No | |
| Comments | form | string | No | |
| UserId | form | string | No | |
| Created | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| QvicklyCheckoutSerialized | form | QvicklyCustomCheckoutData | Yes | |
| StripeCheckoutSerialized | form | StripeCustomCheckoutData | Yes | |
| CompanyId | form | Guid | Yes | |
| InternalReferenceId | form | string | Yes | |
| ArticleTypeId | form | int | Yes | |
| ExternalResponseData | form | string | Yes | |
| ExternalResponseReference | form | string | Yes | |
| PaymentProviderId | form | int | Yes | |
| CreatedDate | form | DateTime | Yes | |
| UpdatedDate | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurrencyId | form | string | Yes | |
| ServicePriceId | form | int? | No | |
| ServicePrice | form | ServicePrice | Yes | |
| CurrencyInfo | form | Currency | Yes | |
| PriceText | form | string | Yes | |
| AppliedCodes | form | List<AppliedRebateCodes> | Yes | |
| IsRebate | form | bool | No | |
| CompanyId | form | Guid | Yes | |
| BookingId | form | int | Yes | |
| Quantity | form | int | Yes | |
| Price | form | double? | No | |
| VAT | form | decimal? | No | |
| Category | form | string | No | |
| Updated | form | DateTime | Yes | |
| Created | form | DateTime | Yes | |
| Invoiced | form | bool | Yes | |
| OccupiesSpot | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Color | form | string | Yes | |
| Icon | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The resource type id |
| Name | form | string | Yes | The resource type name |
| Resources | form | List<BookedResource> | Yes | The resources inside resource type |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | Yes | |
| Color | form | string | Yes | |
| ImageUrl | form | Uri | Yes | |
| form | string | Yes | ||
| MobilePhone | form | string | Yes | |
| AccessGroup | form | string | Yes | |
| EmailNotification | form | bool | No | |
| SMSNotification | form | bool | No | |
| EmailReminder | form | bool | No | |
| SMSReminder | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | Yes | |
| Description | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FreeSpotTextsId | form | int | No | |
| SendEmailConfirmation | form | bool | No | |
| ScheduleViewOptions | form | List<ScheduleView> | Yes | |
| WeekNumberSettingOptions | form | List<WeekNumberSetting> | Yes | |
| BookingTemplateOptions | form | List<BookingTemplate> | Yes | |
| CalendarTypeOptions | form | List<CalendarType> | Yes | |
| FreeSpotTextOptions | form | List<FreeSpotTexts> | Yes | |
| BookingStatusOptions | form | List<BookingStatusOptions> | Yes | |
| FreeSpotTextsInfo | form | FreeSpotTexts | Yes | |
| FreeSpotsTextSingular | form | string | Yes | |
| FreeSpotsTextPlural | form | string | Yes | |
| BookingStatusId | form | int | Yes | |
| ScheduleViewId | form | int | Yes | |
| BookingTemplateId | form | int | Yes | |
| CalendarTypeId | form | int | Yes | |
| AllowBookingOnUnbookedTimes | form | bool | Yes | |
| SendEmailReminder | form | bool | Yes | |
| SendSmsReminder | form | bool | Yes | |
| SendSmsConfirmation | form | bool | Yes | |
| EmailReminderTime | form | int | Yes | |
| SmsReminderTime | form | int | Yes | |
| SendPushNotification | form | bool | Yes | |
| SendPushNotificationReminder | form | bool | Yes | |
| PushNotificationReminderTime | form | int | Yes | |
| MaxActiveBookings | form | int | Yes | |
| SendNotifications | form | bool | Yes | |
| SendNotificationsEmail | form | string | No | |
| EnableMobileApp | form | bool | Yes | |
| ScheduleStartTime | form | TimeSpan? | No | |
| ScheduleEndTime | form | TimeSpan? | No | |
| ReceiptTemplate | form | string | No | |
| ScheduleTimeSlotMinutes | form | int | Yes | |
| ShowFreeTimesLeft | form | bool | Yes | |
| EnableICalGroupBookings | form | bool | Yes | |
| AgreementTemplate | form | string | No | |
| ScheduleShowTimeExeptions | form | bool | Yes | |
| EnableBookingsOnSameTime | form | bool | Yes | |
| ShowWeekNumberSettingId | form | int | Yes | |
| EnableShowBookedTimes | form | bool | Yes | |
| EnableSendFollowUpMessage | form | bool | Yes | |
| FollowUpMessageTime | form | int | Yes | |
| MessageText | form | string | No | |
| ScheduleGroupResources | form | bool | Yes | |
| BookSpotUserResponseMinutes | form | int | Yes | |
| IsBookSpotDirectly | form | bool | Yes | |
| BookSpotDirectlyTimeLeftMinutes | form | int | Yes | |
| SendEmailNotificationQueue | form | bool | Yes | |
| SendSMSNotificationQueue | form | bool | Yes | |
| SchedulerDisableHorizontalScrolling | form | bool | Yes | |
| BookOnlyOnExistingCustomers | form | bool | Yes | |
| AutoGenerateUniquePinCode | form | bool | Yes | |
| WeightedPrices | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| AutoCreateUserProfile | form | bool | Yes | |
| ShowMultipleResourcesAsOne | form | bool | No | |
| ShowMultiDayAsTime | form | bool | No | |
| BookingPinCodeRestriction | form | string | No | |
| CustomerInvoiceAdressRequired | form | bool | No | |
| Id | form | Guid | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| UsedByApplication | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Active | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TextSingular | form | string | Yes | |
| TextPlural | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AdminPaymentOption | form | AdminPaymentOptions | Yes | |
| AdminPaymentOptions | form | List<AdminPaymentOptions> | Yes | |
| PaymentProviderOptions | form | List<PaymentProviders> | Yes | |
| Id | form | Guid | Yes | |
| Enabled | form | bool | Yes | |
| RefundOnCancelBooking | form | bool | Yes | |
| DefaultPaymentOptionId | form | int? | No | |
| PaymentProviderId | form | int | Yes | |
| UpdatedDate | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Category | form | string | Yes | |
| Url | form | string | No | |
| Active | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AverageScore | form | double | No | |
| Score1Count | form | int | No | |
| Score2Count | form | int | No | |
| Score3Count | form | int | No | |
| Score4Count | form | int | No | |
| Score5Count | form | int | No | |
| Count | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReviewId | form | Guid? | No | |
| Review | form | Review | Yes | |
| CompanyId | form | Guid | Yes | |
| BookingId | form | int | Yes | |
| RatingScore | form | int | Yes | |
| Status | form | int | Yes | |
| Created | form | DateTime | Yes | |
| Updated | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReviewId | form | Guid | No | |
| CompanyId | form | Guid | Yes | |
| Title | form | string | Yes | |
| Description | form | string | Yes | |
| Author | form | string | Yes | |
| Status | form | int | Yes | |
| Created | form | DateTime | Yes | |
| Updated | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| ReviewAnswer | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| CustomFieldConfigId | form | int | Yes | |
| ServiceId | form | int | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CodeLockSystemOptions | form | List<CodeLockSystem> | Yes | |
| Active | form | bool | Yes | |
| CodeLockSystemsId | form | int | Yes | |
| ValidBeforeMinutes | form | int | Yes | |
| ValidAfterMinutes | form | int | Yes | |
| DeleteOldBySchedule | form | bool | Yes | |
| Created | form | DateTime | Yes | |
| Updated | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| SendEmailNotification | form | bool | Yes | |
| SendSMSNotification | form | bool | Yes | |
| EmailNotificationTime | form | short | Yes | |
| SMSNotificationTime | form | short | Yes | |
| Id | form | Guid | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Supplier | form | string | Yes | |
| LogoType | form | string | No | |
| Description | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Languages | form | List<LanguageResponse> | Yes | |
| Active | form | bool | Yes | |
| InactiveMessage | form | string | No | |
| Searchable | form | bool | Yes | |
| GATrackingId | form | string | No | |
| FacebookPixelId | form | string | No | |
| MultiLanguage | form | bool | Yes | |
| EnableAPITranslation | form | bool | Yes | |
| DefaultLanguage | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| GTMTrackingId | form | string | No | |
| ShowOnMarketPlace | form | bool | Yes | |
| GoogleAdsConversionId | form | string | No | |
| LinkedinTagId | form | string | No | |
| GoogleAdsConversionLabel | form | string | No | |
| SendCustomerInformationToExternalProviders | form | bool | No | |
| Id | form | Guid | Yes | |
| IsWebhookFeatureEnabled | form | bool | No | |
| SmsMessageSendLimit | form | int? | No | |
| EmailMessageSendLimit | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | Yes | |
| Name | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WidgetServiceLayoutOptions | form | List<WidgetServiceLayouts> | Yes | |
| WidgetTimeLayoutOptions | form | List<WidgetTimeLayouts> | Yes | |
| WidgetBookingLayoutOptions | form | List<WidgetBookingLayouts> | Yes | |
| WidgetBookingMethodOptions | form | List<WidgetBookingMethods> | Yes | |
| ServiceLayoutId | form | int | Yes | |
| TimeLayoutId | form | int | Yes | |
| BookingLayoutId | form | int | Yes | |
| PrimaryColor | form | string | Yes | |
| ShowServiceImage | form | bool | Yes | |
| ShowNextAvailableTime | form | bool | Yes | |
| ShowEndTime | form | bool | Yes | |
| BookedTimeSlotText | form | string | No | |
| DarkTheme | form | bool | Yes | |
| ShowRebateCodeField | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| EnableCreateAccount | form | bool | Yes | |
| EnableLogin | form | bool | Yes | |
| EnableDirectBooking | form | bool | Yes | |
| EnableFacebookLogin | form | bool | Yes | |
| ShowSubscribeToNewsletter | form | bool | Yes | |
| Id | form | Guid | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Code | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Code | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Code | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Code | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HomepageTemplateOptions | form | List<HomepageTemplate> | Yes | |
| HomepageHeroSectionStyleOptions | form | List<HeroSectionStyle> | Yes | |
| CompanyId | form | Guid? | No | |
| WelcomePageHeading | form | string | No | |
| WelcomePageBody | form | string | No | |
| AboutUsPageHeading | form | string | No | |
| AboutUsPageBody | form | string | No | |
| HomePageTemplateId | form | int | Yes | |
| ImageUrl | form | string | No | |
| Updated | form | DateTime | Yes | |
| Created | form | DateTime | Yes | |
| HomepageHeading | form | string | No | |
| HeroSectionStyleId | form | int | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| ShowRating | form | bool | Yes | |
| EnableHomepage | form | bool | Yes | |
| Id | form | Guid | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| ImageUrl | form | Uri | No | |
| Premium | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | LicenseType | Yes | |
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| TypeId | form | int | Yes | |
| ValidFrom | form | DateTime | Yes | |
| ValidTo | form | DateTime | Yes | |
| Active | form | bool | Yes | |
| Updated | form | DateTime | Yes | |
| Created | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| MetaData | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LicenseItems | form | IList<LicenseTypeItem> | Yes | |
| Prices | form | IList<LicensePrice> | Yes | |
| IsFree | form | bool | No | |
| PeriodOfNoticeDays | form | int | No | |
| NextLicenseOption | form | LicenseType | Yes | |
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| ExtraLicenseOption | form | bool | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Active | form | bool | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| LicenseType | form | LicenseType | Yes | |
| LicenseTypesId | form | int | Yes | |
| LicenseItemsId | form | int | Yes | |
| NumberOfItems | form | int | Yes | |
| Id | form | int | No | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Country | form | Country | Yes | |
| MonthlyPayment | form | bool | No | |
| LicenseTypeId | form | int | Yes | |
| CountryId | form | string | Yes | |
| Price | form | int | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurrencyId | form | string | Yes | |
| CurrencyInfo | form | Currency | Yes | |
| Name | form | string | Yes | |
| Culture | form | string | No | |
| TimeZone | form | string | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Resource | form | Resource | Yes | |
| Roles | form | List<KeyCloakRole> | Yes | |
| Company | form | Company | Yes | |
| form | string | Yes | ||
| FullName | form | string | Yes | |
| ResourceId | form | int? | No | |
| WorkerId | form | string | No | |
| Active | form | bool | Yes | |
| IsSuperAdmin | form | bool | Yes | |
| CreatedDate | form | DateTime | Yes | |
| UpdatedDate | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| CompanyId | form | Guid | Yes | |
| Id | form | Guid | Yes | |
| UserId | form | Guid | No | |
| Firstname | form | string | No | |
| Lastname | form | string | No | |
| SendPushNotification | form | bool | Yes | |
| SendPushNotificationReminder | form | bool | Yes | |
| Phone | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Header | form | string | Yes | |
| Description | form | string | Yes | |
| ImageUrl | form | Uri | No | |
| Active | form | bool | Yes | |
| SortOrder | form | int? | No | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | Yes | |
| Id | form | int | No | |
| CustomerId | form | Guid | Yes | |
| Comments | form | string | Yes | |
| Updated | form | DateTime | Yes | |
| Created | form | DateTime | Yes | |
| ImageUrl | form | string | No | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Firstname | form | string | Yes | |
| Lastname | form | string | Yes | |
| form | string | Yes | ||
| Phone | form | string | Yes | |
| ImageUrl | form | string | Yes | |
| CustomFields | form | List<CustomFieldConfigData> | Yes | |
| CustomFieldValues | form | List<CustomFieldDataResponse> | Yes | |
| Comments | form | List<CustomerCommentsResponse> | Yes | |
| AccessKeys | form | List<UserAccessKeys> | Yes | |
| Updated | form | DateTime | No | |
| Created | form | DateTime | No | |
| ResponseStatus | form | Object | Yes | |
| SubscribedToNewsletter | form | bool | No | |
| InvoiceAddress | form | InvoiceAddressResponse | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | Custom field id |
| Name | form | string | Yes | Configuration name. Example: 'Number of persons'. |
| Description | form | string | Yes | Custom field description. Example: 'For how many persons is this booking?' |
| Width | form | int? | No | Field width. Example: 20 for 20px |
| DataType | form | string | Yes | Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox' |
| DefaultValue | form | string | Yes | Default value of the field. Example: '3' |
| IsMandatory | form | bool | No | Determines if the field is required to have a value or not |
| MandatoryErrorMessage | form | string | Yes | Error message shown to the user if the field data is required but not entered |
| MaxLength | form | int | No | Max lenght of the field |
| MultipleLineText | form | bool | No | If the field should have multiple lines |
| RegEx | form | string | Yes | Regular expression used for validation of the field |
| RegExErrorMessage | form | string | Yes | Error message shown if the regular expression validation failed |
| Values | form | List<CustomFieldValueResponse> | Yes | The values to select from if Datatype is DropDown for this custom field |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| CustomerId | form | Guid | No | |
| Comments | form | string | Yes | |
| Updated | form | DateTime | No | |
| Created | form | DateTime | No | |
| ImageUrl | form | Uri | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceAddressId | form | Guid | No | |
| UserId | form | Guid? | No | |
| CorporateIdentityNumber | form | string | Yes | |
| InvoiceAddress1 | form | string | Yes | |
| InvoiceAddress2 | form | string | Yes | |
| InvoiceCity | form | string | Yes | |
| InvoicePostalCode | form | string | Yes | |
| InvoiceCountryCode | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<AccessKeyTypeResponse> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| KeyType | form | string | Yes | |
| Description | form | string | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers HTTP/1.1 Host: api.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Firstname: String,
Lastname: String,
Email: String,
Phone: String,
ImageUrl: String,
CustomFields:
[
{
"Id": 0,
"Name": "String",
"Description": "String",
"Width": 0,
"DataType": "String",
"DefaultValue": "String",
"IsMandatory": false,
"MandatoryErrorMessage": "String",
"MaxLength": 0,
"MultipleLineText": false,
"RegEx": "String",
"RegExErrorMessage": "String",
"Values":
[
{
"Value": "String"
}
]
}
],
CustomFieldValues:
[
{
Id: 0,
Column: String,
Name: String,
Description: String,
Value: String,
DataType: String
}
],
Comments:
[
{
Id: 0,
Comments: String
}
],
AccessKeys:
[
{
AccessKeyTypeId: 0,
Value: String,
Description: String
}
],
ResponseStatus: {},
SubscribedToNewsletter: False,
InvoiceAddress:
{
UserId: 00000000-0000-0000-0000-000000000000,
CorporateIdentityNumber: String,
InvoiceAddress1: String,
InvoiceAddress2: String,
InvoiceCity: String,
InvoicePostalCode: String,
InvoiceCountryCode: String
}
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}