Payment Field Setup - fieldsetup

The fieldsetup transaction retrieves the terminal’s payment field information.

In this section:

For the entire list of API endpoints, refer to API Endpoints.

Request

Field nameDescriptionRequiredLengthData type
ssl_merchant_idMerchant ID
Elavon-assigned Converge Account ID (AID).		Required6 or 7numeric
ssl_user_idConverge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.		Required15alphanumeric
ssl_pinTerminal ID
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
Important: The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.		Required64alphanumeric
ssl_transaction_typeTransaction Type
Value:  fieldsetup		Required20alphanumeric

Response

note

  • The response contains the root XML beginning and ending element <txn>.
  • Within the <txn> element, section information is presented. Data for each section will be nested and embedded between the beginning element <Section> and the ending element </Section>. There can be more than 1 Section elements.
  • Within each Section element, fields are presented. Data for each field resides between the beginning element <Field> and the ending ending </Field>. There can be more than 1 Field elements.
Field nameDescription
NameSection Name
As configured by Converge.
DisplayNameSection Label
As configured by the merchant.
ShowinVTShow Section Under Payment Menu
Indicates if the section appears (Y>) or does not appear (N) under the Payment menu of the Virtual Terminal.
ShowOnPaymentFormShow Section On Payment Form
Indicates if the section appears (Y) or does not appear (N) on the Payment page under the Payment menu.
ShowinReceiptShow Section On Receipt
Indicates if the section appears (Y) or does not appear (N) on the receipt.
CustomerEmailShow Customer Email in Section
Indicates if the customer’s email address appears (Y) or does not appear (N) in the section.
MerchantEmailShow Merchant Email in Section
Indicates if the merchant’s email address appears (Y) or does not appear (N) in the section.
FieldField Data Elements
  • Name - Field Name
  • DisplayName - Field Label
  • Section - Section in which the field appears.
  • FieldType - Data Type
  • Min - Minimum Length
  • Max - Maximum Length
  • Required - Indicates if the field is mandatory (Y) or optional (N)
  • ChangedOnPaymentForm - Indicates if the field is editable (Y or non-editable (N) in the Payment Form of the Virtual Terminal.
  • ShowonPaymentForm - Indicates if the field appears (Y) or does not appear (N) on the Payment page.
  • ShowinReceipt - Indicates if the field appears (Y) or does not appear (N) on the receipt.
  • CustomerEmail - Indicates if the field appears (Y) or does not appear (N) in the customer’s email.
  • MerchantEmail - Indicates if the field appears (Y) or does not appear (N) in the merchant’s email.
  • ForwardOnApproval - Indicates if the field is forwarded (Y) or not forwarded (N) on approvals.
  • ForwardOnDecline - Indicates if the field is forwarded (Y) or is not forwarded (N) on declines.
  • SystemField - Indicates if the field is a system field (Y) or a custom field (N).

Example

important

  • In this example, you will have to change the data values, such as my_merchant_id, my_user_id, my_pin, and transaction data to match your Converge account and meet the needs of your website.
  • Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.

Request

    xmldata=
    <txn>
        <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
        <ssl_user_id>my_user_id</ssl_user_id>
        <ssl_pin>my_pin</ssl_pin>
        <ssl_transaction_type>fieldsetup</ssl_transaction_type>
    </txn>

Response

    <txn>
        <Section>
            <Name>OrderSection</Name>
            <DisplayName>Order Section</DisplayName>
            <ShowinVT>Y</ShowinVT>
            <ShowOnPaymentForm>Y</ShowOnPaymentForm>
            <ShowinReceipt>Y</ShowinReceipt>
            <CustomerEmail>Y</CustomerEmail>
            <MerchantEmail>Y</MerchantEmail>
            <Field>
                <Name>ssl_account_data</Name>
                <DisplayName>Order Section</DisplayName>
                <Section>OrderSection</Section>
                <FieldType>TEXT</FieldType>
                <Min>0</Min>
                <Max>19</Max>
                <Required>Y</Required>
                <ShowinVT>Y</ShowinVT>
                <ChangedOnPaymentForm>N</ChangedOnPaymentForm>
                <ShowOnPaymentForm>Y</ShowOnPaymentForm>
                <ShowinReceipt>Y</ShowinReceipt>
                <CustomerEmail>Y</CustomerEmail>
                <MerchantEmail>Y</MerchantEmail>
                <ForwardOnApproval>Y</ForwardOnApproval>
                <ForwardOnDecline>Y</ForwardOnDecline>
                <SystemField>Y</SystemField>
            </Field>
        </Section>
        <Section>
            <Name>CustomFields</Name>
            <DisplayName>Custom Fields</DisplayName>
            <ShowinVT>Y</ShowinVT>
            <ShowOnPaymentForm>Y</ShowOnPaymentForm>
            <ShowinReceipt>Y</ShowinReceipt>
            <CustomerEmail>Y</CustomerEmail>
            <MerchantEmail>Y</MerchantEmail>
            <Field>
                <Name>MyCustom</Name>
                <DisplayName>Custom Fields</DisplayName>
                <Section>CustomFields</Section>
                <FieldType>TEXT</FieldType>
                <Min>5</Min>
                <Max>12</Max>
                <Required>Y</Required>
                <ShowinVT>Y</ShowinVT>
                <ChangedOnPaymentForm>Y</ChangedOnPaymentForm>
                <ShowOnPaymentForm>Y</ShowOnPaymentForm>
                <ShowinReceipt>Y</ShowinReceipt>
                <CustomerEmail>Y</CustomerEmail>
                <MerchantEmail>Y</MerchantEmail>
                <ForwardOnApproval>N</ForwardOnApproval>
                <ForwardOnDecline>N</ForwardOnDecline>
                <SystemField>N</SystemField>
            </Field>
        </Section>
    </txn>