PayConexDecryptxShieldConexTECS
API Reference
Request SandboxContact Us
  1. PayConex 4
  2. Payment Form

Create instance details.

post
https://api-cert.payconex.net/api/v4/accounts//payment-form//instance/init

Create an instance of the Payment Form.

Required Scopes

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

  • pcx:hosted_payment_form:instance:*
  • pcx:hosted_payment_form:instance:create
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^\d{12}$
string
required
^hpf_[0-9a-fA-F]{32}$
Body Params

Create payment form instance body

string
required
^[0-9a-zA-z-_\s]{3,100}$

A word or short phrase that describes the payment form instance.

string
string
^[0-9a-zA-z-_\s]{1,100}$

Merchant reference.

string
enum
Allowed:
confirmationPage
object
customer
object

Prefilled customer data for the payment form instance. This does not override the payment form capture configuration.

shippingAddress
object
string
enum
Defaults to required

Whether the user has the option to save the payment option

optiondescription
requiredPayment option will always be saved
optionalThe user has the option to save the payment option
omitThere will be no option to save the payment option
Allowed:
ecommerceSettings
object
donationSettings
object
allowedPaymentMethods
array of strings
allowedPaymentMethods
Allowed:
style
object
threeDSecure
object
termsAndCond
object
integer
300 to 1800
Defaults to 1800

Timeout in seconds for the payment form instance.

customFieldValues
array of objects
customFieldValues
Responses

Updated 2 days ago

Did this page help you?
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

Updated 2 days ago

Did this page help you?