Skip to main content

Dynamic Form

GET 
/channels/:ChannelID/form

This endpoint provides a JSONForm schema needed to configure payment methods for transactions on a specified channel. Use this schema to dynamically generate forms based on the selected payment method. The ChannelID parameter, obtainable from the Supported Channels endpoint, specifies the target channel for which the form is generated.

Note: It is not possible to fetch schemas for channels where the PaymentMethodType is set to TokenizedCard, as the API does not directly accept credit card details. For credit card payments, please refer to the Hosted Checkout solution.

Request​

Path Parameters

    ChannelID uuidrequired

    Possible values: >= 36 characters and <= 36 characters

Query Parameters

    PaymentMethodID FiatPaymentMethodID

    Possible values: non-empty and <= 150 characters

Header Parameters

    Api-Signature string

    Digitally signed JWT.

Responses​

Payment method form schema
Schema
    FormSchemaobject

    Form schema which needs to be filled by the customer. If no customer input is required, this field is omitted.

    $schema stringrequired
    Example: http://json-schema.org/draft-07/schema#
    type stringrequired
    Example: object

    properties

    objectrequired
    property name* any
    required string[]
    allOf object[]
Loading...