Skip to navigation
Manage payment operationsMerchant boardingAPI

Manage boarding templates with the API

Beta
Learn how to list, read, update, and archive boarding templates with the Payabli API
View as MarkdownOpen in Claude
Applies to:Developers

Intelligent boarding is in beta. To opt in, reach out to your Payabli contact.

A boarding template shapes the application experience for your customers: the services, fields, documents, and options an applicant sees. Tailor a template to a specific customer or paypoint type — for example, to prefill known details, or to apply a stricter flow for high-risk boarding. You can set a template up for Pay In, Pay Out, or both. Use the boarding templates API to find templates, read their content, and manage them as you board. For how templates fit into the wider model, see the boarding overview.

Considerations

  • The boarding API uses OAuth2. Send a Bearer token on every request. See OAuth2 authentication.
  • Templates are created and edited in the Payabli Portal. This API reads templates and their versions, and archives templates.
  • An organization can use templates it owns and templates inherited from ancestor organizations. Scope a listing with the required orgId query parameter.

List templates

Send a GET request to /v2/templates with the required orgId query parameter. The response includes templates the organization owns plus templates inherited from ancestor organizations. Filter by status, name, slug, orgName, and inherited, and page with fromRecord and limitRecord. See the API reference for this endpoint for full documentation.

GET
/api/v2/templates
curl -G https://api-sandbox.payabli.com/api/v2/templates \
     -H "Authorization: Bearer <token>" \
     -d orgId=123
Try it

The response returns a page of templates with pagination metadata:

Response
{
  "Summary": {
    "totalPages": 1,
    "totalRecords": 1,
    "pageSize": 20
  },
  "Records": [
    {
      "uuid": "019ff129-d393-7761-9a31-e5afe85b4081",
      "orgId": 123,
      "orgName": "PropertyManager Pro",
      "name": "Standard boarding template",
      "description": null,
      "slug": null,
      "status": "active",
      "currentVersionUuid": "019ff129-d396-74c4-86da-ae3d082d7ef9",
      "currentVersion": {
        "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"
      },
      "isInherited": false,
      "readOnly": false,
      "createdBy": "0",
      "updatedBy": "0",
      "createdAt": "2026-07-01T15:00:01.035727",
      "updatedAt": "2026-07-01T15:00:01.040548"
    }
  ]
}

Get a template

Send a GET request to /v2/templates/{uuid}. The response includes the template’s current content version. See the API reference for this endpoint for full documentation.

GET
/api/v2/templates/:uuid
curl https://api-sandbox.payabli.com/api/v2/templates/019ff129-d393-7761-9a31-e5afe85b4081 \
     -H "Authorization: Bearer <token>"
Try it

The response returns the template and its current version:

Response
{
  "uuid": "019ff129-d393-7761-9a31-e5afe85b4081",
  "orgId": 123,
  "orgName": "PropertyManager Pro",
  "name": "Standard boarding template",
  "description": null,
  "slug": null,
  "status": "active",
  "currentVersionUuid": "019ff129-d396-74c4-86da-ae3d082d7ef9",
  "currentVersion": {
    "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"
  },
  "isInherited": false,
  "readOnly": false,
  "createdBy": "0",
  "updatedBy": "0",
  "createdAt": "2026-07-01T15:00:01.035727",
  "updatedAt": "2026-07-01T15:00:01.040548"
}

The currentVersionUuid points at the active version. Each save in the Portal appends a new version, so you can read an earlier one by its own UUID.

Get a template version

Send a GET request to /v2/templates/{uuid}/versions/{versionUuid} to read a specific content version. Versions are immutable snapshots. See the API reference for this endpoint for full documentation.

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>"
Try it

The response returns the version snapshot:

Response
{
  "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"
}

Archive a template

Send a DELETE request to /v2/templates/{uuid}. This is a soft delete: the template moves to archived and stays readable. A successful archive returns 204 No Content. Archiving a template that’s already archived returns 409. See the API reference for this endpoint for full documentation.

DELETE
/api/v2/templates/:uuid
curl -X DELETE https://api-sandbox.payabli.com/api/v2/templates/019ff129-d393-7761-9a31-e5afe85b4081 \
     -H "Authorization: Bearer <token>"
Try it

See these related resources to help you get the most out of Payabli.