---
title: "Combo API to generate form data to redirect the customer to the gateway"
method: POST
path: "/1.0/kb/paymentGateways/hosted/form"
tags: ["PaymentGateway"]
---

# Combo API to generate form data to redirect the customer to the gateway

`POST /1.0/kb/paymentGateways/hosted/form`

## Query parameters

- `controlPluginName` string[]
- `pluginProperty` string[]

## Headers

- `X-Killbill-CreatedBy` string, required
- `X-Killbill-Reason` string
- `X-Killbill-Comment` string

## Request body

- ComboHostedPaymentPage
  - `account` Account
    - `accountId` string, uuid
    - `name` string
    - `firstNameLength` integer
    - `externalKey` string
    - `email` string
    - `billCycleDayLocal` integer
    - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD' | 'BTC'
    - `parentAccountId` string, uuid
    - `isPaymentDelegatedToParent` boolean
    - `paymentMethodId` string, uuid
    - `referenceTime` string, date-time
    - `timeZone` string
    - `address1` string
    - `address2` string
    - `postalCode` string
    - `company` string
    - `city` string
    - `state` string
    - `country` string
    - `locale` string
    - `phone` string
    - `notes` string
    - `isMigrated` boolean
    - `accountBalance` number
    - `accountCBA` number
    - `auditLogs` AuditLog[]
      - `changeType` string
      - `changeDate` string, date-time
      - `objectType` 'ACCOUNT' | 'ACCOUNT_EMAIL' | 'BLOCKING_STATES' | 'BUNDLE' | 'CUSTOM_FIELD' | 'INVOICE' | 'PAYMENT' | 'TRANSACTION' | 'INVOICE_ITEM' | 'INVOICE_PAYMENT' | 'SUBSCRIPTION' | 'SUBSCRIPTION_EVENT' | 'SERVICE_BROADCAST' | 'PAYMENT_ATTEMPT' | 'PAYMENT_METHOD' | 'TAG' | 'TAG_DEFINITION' | 'TENANT' | 'TENANT_KVS'
      - `objectId` string, uuid
      - `changedBy` string
      - `reasonCode` string
      - `comments` string
      - `userToken` string
      - `history` Entity
        - `id` string, uuid
        - `updatedDate` string, date-time
        - `createdDate` string, date-time
  - `paymentMethod` PaymentMethod
    - `paymentMethodId` string, uuid
    - `externalKey` string
    - `accountId` string, uuid
    - `isDefault` boolean
    - `pluginName` string
    - `pluginInfo` PaymentMethodPluginDetail
      - `externalPaymentMethodId` string
      - `isDefaultPaymentMethod` boolean
      - `properties` PluginProperty[]
        - `key` string
        - `value` string
        - `isUpdatable` boolean
    - `auditLogs` AuditLog[]
      - `changeType` string
      - `changeDate` string, date-time
      - `objectType` 'ACCOUNT' | 'ACCOUNT_EMAIL' | 'BLOCKING_STATES' | 'BUNDLE' | 'CUSTOM_FIELD' | 'INVOICE' | 'PAYMENT' | 'TRANSACTION' | 'INVOICE_ITEM' | 'INVOICE_PAYMENT' | 'SUBSCRIPTION' | 'SUBSCRIPTION_EVENT' | 'SERVICE_BROADCAST' | 'PAYMENT_ATTEMPT' | 'PAYMENT_METHOD' | 'TAG' | 'TAG_DEFINITION' | 'TENANT' | 'TENANT_KVS'
      - `objectId` string, uuid
      - `changedBy` string
      - `reasonCode` string
      - `comments` string
      - `userToken` string
      - `history` Entity
        - `id` string, uuid
        - `updatedDate` string, date-time
        - `createdDate` string, date-time
  - `hostedPaymentPageFields` HostedPaymentPageFields
    - `formFields` PluginProperty[]
      - `key` string
      - `value` string
      - `isUpdatable` boolean
  - `paymentMethodPluginProperties` PluginProperty[]
    - `key` string
    - `value` string
    - `isUpdatable` boolean
  - `auditLogs` AuditLog[]
    - `changeType` string
    - `changeDate` string, date-time
    - `objectType` 'ACCOUNT' | 'ACCOUNT_EMAIL' | 'BLOCKING_STATES' | 'BUNDLE' | 'CUSTOM_FIELD' | 'INVOICE' | 'PAYMENT' | 'TRANSACTION' | 'INVOICE_ITEM' | 'INVOICE_PAYMENT' | 'SUBSCRIPTION' | 'SUBSCRIPTION_EVENT' | 'SERVICE_BROADCAST' | 'PAYMENT_ATTEMPT' | 'PAYMENT_METHOD' | 'TAG' | 'TAG_DEFINITION' | 'TENANT' | 'TENANT_KVS'
    - `objectId` string, uuid
    - `changedBy` string
    - `reasonCode` string
    - `comments` string
    - `userToken` string
    - `history` Entity
      - `id` string, uuid
      - `updatedDate` string, date-time
      - `createdDate` string, date-time

## Response `200`

successful operation

- HostedPaymentPageFormDescriptor
  - `kbAccountId` string, uuid
  - `formMethod` string
  - `formUrl` string
  - `formFields` object
  - `properties` object
  - `auditLogs` AuditLog[]
    - `changeType` string
    - `changeDate` string, date-time
    - `objectType` 'ACCOUNT' | 'ACCOUNT_EMAIL' | 'BLOCKING_STATES' | 'BUNDLE' | 'CUSTOM_FIELD' | 'INVOICE' | 'PAYMENT' | 'TRANSACTION' | 'INVOICE_ITEM' | 'INVOICE_PAYMENT' | 'SUBSCRIPTION' | 'SUBSCRIPTION_EVENT' | 'SERVICE_BROADCAST' | 'PAYMENT_ATTEMPT' | 'PAYMENT_METHOD' | 'TAG' | 'TAG_DEFINITION' | 'TENANT' | 'TENANT_KVS'
    - `objectId` string, uuid
    - `changedBy` string
    - `reasonCode` string
    - `comments` string
    - `userToken` string
    - `history` Entity
      - `id` string, uuid
      - `updatedDate` string, date-time
      - `createdDate` string, date-time

## Other responses

- `400` — Invalid data for Account or PaymentMethod

---

[API](https://skmtc.net/killbill/apis/kill-bill.md) · [All operations](https://skmtc.net/killbill/apis/kill-bill/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/killbill/kill-bill/revisions/0fb95d23caf5/schema)