Payments Integration Spec Pack

Payments Integration Spec Pack turns structured merchant and acquirer integration details into a branded PDF integration specification with a completeness report, stripping secrets and card numbers automatically.

Best for: Payments integration and solutions engineers, implementation managers at PSPs and acquirers, and merchants preparing for go-live.

How to generate a payments integration spec

1. Fill in Integration details (spec): merchant, acquirer, MIDs, MCC, 3DS, endpoints, webhooks, settlement, contacts, timeline and sign-off.
2. Optionally set Brand name and Brand colour.
3. Click Start, then open pdfUrl to download SPEC.pdf.

How it works

The PDF (SPEC.pdf) and a JSON report (REPORT) are saved to the run's key-value store; the dataset row has the completeness summary and PDF link. Completeness covers 23 required fields. Secret protection: fields named like passwords, secrets, API keys, tokens, private keys, PIN, CVV or PAN are replaced, and values that look like Stripe-style keys, webhook secrets, AWS keys, JWTs, PEM private keys, long hex/base64 strings or Luhn-valid card numbers are redacted wherever they appear.

Output

title, completenessPercent, missingFields, tbdFields, openSignOffItems, redactions, pdfUrl

Pricing (pay-per-event)

• spec-pack-generated: $0.05 per result ($50 / 1,000). Platform usage is included; you pay only for results.
• Example: 10,000 spec packs cost $500.00.

Example input

{
  "spec": {
    "project": {
      "name": "Example Shop card acceptance",
      "version": "0.1"
    },
    "merchant": {
      "legalName": "Example Shop Ltd",
      "tradingName": "Example Shop",
      "country": "GB",
      "companyNumber": "00000000",
      "website": "https://shop.example.com"
    },
    "acquirer": {
      "name": "Example Acquirer",
      "psp": "Example PSP"
    },
    "mids": [
      "MID-0001 (GBP ecom)"
    ],
    "tids": [],
    "mcc": "5999",
    "schemes": [
      "Visa",
      "Mastercard"
    ],
    "paymentMethods": [
      "Cards",
      "Apple Pay",
      "Google Pay"
    ],
    "currencies": [
      "GBP",
      "EUR"
    ],
    "settlementCurrency": "GBP",
    "threeDS": {
      "version": "2.2",
      "challengePreference": "no preference",
      "scaExemptions": [
        "Low value",
        "TRA"
      ]
    },
    "endpoints": {
      "test": "https://api.test.example-psp.com",
      "live": "TBD"
    },
    "webhooks": {
      "url": "https://shop.example.com/webhooks/psp",
      "events": [
        "payment.authorised",
        "payment.captured",
        "refund.succeeded",
        "chargeback.created"
      ],
      "authMethod": "HMAC signature header"
    },
    "settlement": {
      "schedule": "T+2 daily",
      "bankAccountRef": "Barclays ****1234"
    },
    "contacts": [
      {
        "role": "Merchant tech lead",
        "name": "Alex Example",
        "email": "alex@example.com"
      },
      {
        "role": "PSP integration manager",
        "name": "Sam Example",
        "email": "sam@example-psp.com"
      }
    ],
    "timeline": {
      "kickoff": "2026-11-02",
      "uat": "2026-11-20",
      "goLive": "2026-12-01"
    },
    "signOff": [
      {
        "item": "Test transactions passed (auth, capture, refund)",
        "owner": "Merchant",
        "done": true
      },
      {
        "item": "3DS challenge flow tested",
        "owner": "Merchant",
        "done": false
      },
      {
        "item": "Webhook signature verification",
        "owner": "Merchant",
        "done": false
      },
      {
        "item": "Go-live approval",
        "owner": "PSP",
        "done": false
      }
    ]
  },
  "brandName": "SterlingVerify"
}

Example output

Values below are illustrative.

{
  "title": "Integration Specification - Example Shop",
  "completenessPercent": 96,
  "missingFields": [],
  "tbdFields": [
    {
      "field": "endpoints.live",
      "label": "Live endpoint(s)"
    }
  ],
  "openSignOffItems": [
    "3DS challenge flow tested"
  ],
  "redactions": [],
  "pdfUrl": "https://api.apify.com/v2/key-value-stores/.../records/SPEC.pdf"
}

Use it via API, schedules and integrations

Run it in Apify Console, or call it from your own code with the Apify API or the Python and JavaScript clients. Save an input as a task and add a schedule to run it regularly, and send results to Slack, email, webhooks, Zapier, Make or n8n with Apify integrations. AI agents can find and run it through the Apify MCP server.

from apify_client import ApifyClient

client = ApifyClient("YOUR_APIFY_TOKEN")
run = client.actor("sterlingverify/integration-spec-pack").call(run_input=your_input  # same JSON as the example input above)
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

Use in Clay, Zapier, Make, n8n, Pipedream, Power Automate or Activepieces

All of them connect to Apify through their official Apify integrations, using your own Apify account: an API token from Apify Console > Settings > API & Integrations, or Apify sign-in for Power Automate. Runs bill to your Apify account at this Actor's pay-per-event price.

• Clay: save this Actor's input as an Apify task and copy it as JSON. In your Clay table, add the Run Apify Actor enrichment, choose it and paste the JSON into Input Data, mapping Clay columns into the fields. To pull a finished run into a new table, use the Import data from Apify Actor source.
• Zapier: use the Apify Run Actor action, or the Finished Actor run trigger followed by Fetch dataset items. Synchronous runs in Zapier stop after 30 seconds, so use the trigger for big batches.
• Make: add the Apify Run an Actor module with Run synchronously set to Yes, then Get Dataset Items with the run's dataset ID. For longer runs, use the Watch Actor Runs trigger.
• n8n: install the Apify node (@apify/n8n-nodes-apify, or search "Apify" on n8n Cloud) and use Run an Actor and get dataset.
• Pipedream: add the Apify app's Run Actor action, or Run Task Synchronously on one of this Actor's public example tasks (or your own saved task) to get the dataset items back in one step. For big batches, start from the New Finished Actor Run or New Finished Task Run trigger, then Get Dataset Items.
• Power Automate: add the Apify connector (a premium connector, currently in preview) and sign in with your Apify account. Use Run Actor with Enter custom value set to sterlingverify/integration-spec-pack and paste the input as JSON, then Get dataset items with the run's default dataset ID. For big batches, start the flow from the Actor run finished trigger instead.
• Activepieces: add the Apify piece and use Run Actor, or Run Task on one of this Actor's public example tasks (or your own saved task), then Get Dataset Items. For scheduled or big batches, use the Watch Actor Runs or Watch Task Runs trigger.
• Google Drive / Sheets: add Apify's Upload results to GDrive integration to a scheduled task to drop each run's CSV or XLSX into your team's Drive, or chain the Google Sheets Import & Export actor to append rows to a sheet.
• Slack alerts: add Apify's Slack integration to a scheduled task to post each run's results to your team channel, or start a check from Slack with /apify call and your task ID.
• Any HTTP tool or script: send one request and get the results back as JSON. Runs must finish within 5 minutes.

curl -X POST "https://api.apify.com/v2/acts/sterlingverify~integration-spec-pack/run-sync-get-dataset-items" \
  -H "Authorization: Bearer YOUR_APIFY_TOKEN" \
  -H "Content-Type: application/json" \
  -d @input.json

FAQ

What does the completeness report check?

23 required fields, plus fields marked TBD and open sign-off items.

Should I put live credentials in the input?

No. Redaction is pattern-based and can miss things, and Apify stores run inputs, so never include live credentials or cardholder data.

Disclaimer

A documentation aid, not a contract or a compliance artefact; confirm all details with your acquirer/PSP. Redaction is pattern-based and can miss things, so never put live credentials or cardholder data in the input (Apify stores run inputs). Not affiliated with any acquirer, PSP or card scheme.

Related sterlingVerify tools

Part of the sterlingVerify UK payments, KYB and data toolkit on Apify Store:

• Payments Region Checker: EEA, SEPA, SCA and interchange classification by country or BIN
• MCC Checker: check a merchant's MCC against its website or description
• PCI Readiness Scanner: passive checkout security check with a likely SAQ type
• PSP Status Monitor: outage alerts from payment provider status pages