Create Payment Form configuration set.

Create a Payment Form

Endpoint to create a Payment Form

Required Scopes

The API Key calling this endpoint must have one of the following scopes:

  • pcx:hosted_payment_form:*
  • pcx:hosted_payment_form:create
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^\d{12}$
Body Params

Create Payment Form Body

string
required
^[0-9a-zA-z-_\s]{3,100}$
string
required
boolean
string
enum
required
Allowed:
string
enum
Allowed:
integer
300 to 1800
Defaults to 1800

Default payment form instance timeout in seconds.

string
enum
required
Allowed:
allowedPaymentMethods
array of strings
required
allowedPaymentMethods*
Allowed:
confirmationPage
object
ecommerceSettings
object
donationSettings
object
customer
object
shippingAddress
object
style
object
threeDSecure
object
termsAndCond
object
branding
object
customFields
array of objects

Ordered list of custom field option IDs to show on the form

customFields
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json