Get a template version

Beta

GET

/v2/templates/:uuid/versions/:versionUuid

GET

/api/v2/templates/:uuid/versions/:versionUuid

curl https://api-sandbox.payabli.com/api/v2/templates/019ff129-d393-7761-9a31-e5afe85b4081/versions/019ff129-d396-74c4-86da-ae3d082d7ef9 \
     -H "Authorization: Bearer <token>"

{
  "uuid": "019ff129-d396-74c4-86da-ae3d082d7ef9",
  "version": 1,
  "services": {
    "ach": "merchantDecision",
    "card": "preSelected",
    "checkRdc": "merchantDecision"
  },
  "fieldConfigurations": [
    {
      "attributes": [
        "required",
        "visible"
      ],
      "defaultValue": null,
      "fieldPath": "business.website",
      "hint": null,
      "label": "Website"
    },
    {
      "attributes": [
        "required",
        "visible"
      ],
      "custom": true,
      "defaultValue": null,
      "fieldPath": "business.salesChannel",
      "hint": null,
      "label": "Sales Channel",
      "options": [
        "In-Store",
        "Online",
        "Both"
      ],
      "questionType": "multipleChoiceSingle"
    },
    {
      "attributes": [
        "required",
        "visible"
      ],
      "custom": true,
      "defaultValue": null,
      "fieldPath": "business.customerType",
      "hint": null,
      "label": "Primary Customer Type",
      "options": [
        "B2B",
        "B2C",
        "Both"
      ],
      "questionType": "multipleChoiceSingle"
    },
    {
      "attributes": [
        "required",
        "visible"
      ],
      "custom": true,
      "defaultValue": null,
      "fieldPath": "business.yearsInBusiness",
      "hint": null,
      "label": "Years in Business",
      "options": [
        "Less than 1",
        "1-3",
        "3-5",
        "5-10",
        "10+"
      ],
      "questionType": "dropdown"
    },
    {
      "attributes": [
        "visible"
      ],
      "custom": true,
      "defaultValue": null,
      "fieldPath": "business.refundPolicy",
      "hint": null,
      "label": "Describe your refund policy",
      "options": null,
      "questionType": "textarea"
    }
  ],
  "conditionalRules": [
    {
      "actions": [
        {
          "actionType": "setFieldAttributes",
          "fieldPath": "business.website",
          "readOnly": null,
          "required": true,
          "visible": null
        }
      ],
      "conditions": [
        {
          "fieldPath": "business.salesChannel",
          "operator": "equals",
          "value": "Online"
        }
      ],
      "description": "Require the website field when sales happen online.",
      "enabled": true,
      "matchMode": "all",
      "ruleName": "require-website-online"
    },
    {
      "actions": [
        {
          "actionType": "setFieldAttributes",
          "fieldPath": "business.refundPolicy",
          "readOnly": null,
          "required": true,
          "visible": true
        }
      ],
      "conditions": [
        {
          "fieldPath": "business.merchantCatCode",
          "operator": "equals",
          "value": "3000"
        }
      ],
      "description": "Require the refund policy field when the merchant category code (MCC) is 3000 (airlines).",
      "enabled": true,
      "matchMode": "all",
      "ruleName": "require-refund-policy-airlines"
    }
  ],
  "documents": [
    {
      "allowedFormats": [
        "pdf",
        "jpg",
        "png"
      ],
      "attributes": [
        "required",
        "visible"
      ],
      "fieldPath": "documents.bankStatement",
      "hint": "3 most recent months",
      "label": "Bank Statement",
      "maxUploads": 3,
      "preset": true
    }
  ],
  "devices": [
    {
      "deviceId": "ingenico_axium_dx8",
      "preSelected": false
    },
    {
      "deviceId": "ingenico_axium_rx9000",
      "preSelected": false
    }
  ],
  "hiddenSections": [
    "welcome"
  ],
  "allowedMccs": [
    5200,
    8998
  ],
  "underwriting": "automatic",
  "mpaContent": "<p>Merchant Processing Agreement</p>",
  "payinPricingId": 1289,
  "payoutPricingId": null,
  "allowGuidedTour": false,
  "allowBusinessPrefill": true,
  "allowSaveForLater": true,
  "allowMultipleBanks": true,
  "allowServiceSelection": true,
  "allowDeviceSelection": true,
  "allowAmigoChat": true,
  "allowUserCreation": true,
  "allowPeoplePrefill": false,
  "verticalProgress": true,
  "useFloatingInputs": false,
  "centerContent": true,
  "allowRealTimeBankVerification": true,
  "allowCheckboxSigning": true,
  "allowTypedSignature": true,
  "allowWrittenSignature": true,
  "allowMultiOwnerEsign": false,
  "allowConfirmationAndAttestation": true,
  "allowPCIAttestation": false,
  "createdAt": "2026-07-01T15:00:01.038310",
  "createdBy": "0"
}

Retrieves a specific immutable content version of a template.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

uuidstringRequired

The template's UUID.

versionUuidstringRequired

The version's UUID.

Response

The template version.

uuidstringformat: "uuid"

The version's unique identifier.

versioninteger

The version number, starting at 1 and incrementing on each save.

servicesobject or null

The processing services offered on the boarding form. Configured in the Payabli Portal.

fieldConfigurationslist of any or null

Per-field configuration for the boarding form. Configured in the Payabli Portal.

conditionalRuleslist of any or null

Rules that show, hide, or require fields based on other answers. Configured in the Payabli Portal.

documentslist of any or null

Document upload requirements for the boarding form. Configured in the Payabli Portal.

deviceslist of any or null

The devices offered during boarding. Configured in the Payabli Portal.

hiddenSectionslist of any or null

Sections hidden from the boarding form. Configured in the Payabli Portal.

allowedMccslist of integers or null

The merchant category codes (MCCs) allowed for applications from this template. Configured in the Payabli Portal.

underwritingenum

How applications from this template are underwritten.

Allowed values:

mpaContentstring or null

The merchant processing agreement content shown during boarding.

payinPricingIdinteger or null

The Pay In pricing configuration applied to applications from this template.

payoutPricingIdinteger or null

The Pay Out pricing configuration applied to applications from this template.

allowGuidedTourboolean

Whether the boarding form shows a guided tour.

allowBusinessPrefillboolean

Whether business fields can be prefilled.

allowSaveForLaterboolean

Whether applicants can save progress and resume later.

allowMultipleBanksboolean

Whether applicants can add more than one bank account.

allowServiceSelectionboolean

Whether applicants can choose their processing services.

allowDeviceSelectionboolean

Whether applicants can select devices.

allowAmigoChatboolean

Whether the Amigo assistant is available during boarding.

allowUserCreationboolean

Whether applicants can create a user account during boarding.

allowPeoplePrefillboolean

Whether people fields can be prefilled.

verticalProgressboolean

Whether the progress indicator is shown vertically.

useFloatingInputsboolean

Whether form inputs use floating labels.

centerContentboolean

Whether the boarding form content is centered.

allowRealTimeBankVerificationboolean

Whether bank accounts are verified in real time.

allowCheckboxSigningboolean

Whether applicants can sign with a checkbox.

allowTypedSignatureboolean

Whether applicants can sign by typing their name.

allowWrittenSignatureboolean

Whether applicants can sign by drawing a signature.

allowMultiOwnerEsignboolean

Whether multiple owners can e-sign the application.

allowConfirmationAndAttestationboolean

Whether the confirmation and attestation step is shown.

allowPCIAttestationboolean

Whether the PCI attestation step is shown.

createdAtstring

When the version was created.

createdBystring

The identifier of the user who created the version.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error