# Payments Integration Spec Pack (`sterlingverify/integration-spec-pack`) Actor Turn structured merchant and acquirer integration details (MIDs/TIDs, MCC, schemes, currencies, 3DS/SCA, test/live endpoints, webhooks, settlement, contacts, timeline, sign-off) into a branded PDF spec with a completeness report. Secrets and card numbers are automatically stripped. - **URL**: https://apify.com/sterlingverify/integration-spec-pack.md - **Developed by:** [Luke Mangan](https://apify.com/sterlingverify) (community) - **Categories:** Business, Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing $50.00 / 1,000 spec pack generateds This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event ## What's an Apify Actor? An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md. ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run. For examples already wired to this Actor's own input schema, see the [API](#api) section below. Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`). # README ## 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 ```json { "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. ```json { "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. ```python 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) ``` ### 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](https://apify.com/sterlingverify/payments-region-checker): EEA, SEPA, SCA and interchange classification by country or BIN - [MCC Checker](https://apify.com/sterlingverify/mcc-checker): check a merchant's MCC against its website or description - [PCI Readiness Scanner](https://apify.com/sterlingverify/pci-readiness-scanner): passive checkout security check with a likely SAQ type - [PSP Status Monitor](https://apify.com/sterlingverify/psp-status-monitor): outage alerts from payment provider status pages # Actor input Schema ## `spec` (type: `object`): Sections: project{name,version}, merchant{legalName,tradingName,country,companyNumber,website}, acquirer{name,psp}, mids\[], tids\[], mcc, schemes\[], paymentMethods\[], currencies\[], settlementCurrency, threeDS{version,challengePreference,scaExemptions\[]}, endpoints{test,live}, webhooks{url,events\[],authMethod}, settlement{schedule,bankAccountRef}, contacts\[{role,name,email,phone}], timeline{kickoff,uat,goLive}, signOff\[{item,owner,done}], notes. Use "TBD" for unknowns. NEVER include API keys, passwords or card numbers: they are detected and replaced with placeholders. ## `brandName` (type: `string`): Shown in the PDF header and footer. ## `brandColor` (type: `string`): Header and table colour. ## Actor input object example ```json { "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", "brandColor": "#0B1F3A" } ``` # Actor output Schema ## `results` (type: `string`): All results in the default dataset # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const 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 } ] } }; // Run the Actor and wait for it to finish const run = await client.actor("sterlingverify/integration-spec-pack").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_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, }, ], } } # Run the Actor and wait for it to finish run = client.actor("sterlingverify/integration-spec-pack").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}") for item in client.dataset(run.default_dataset_id).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "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 } ] } }' | apify call sterlingverify/integration-spec-pack --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "type": "http", "url": "https://mcp.apify.com/?tools=fetch-actor-details,sterlingverify/integration-spec-pack" } } } ``` The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer ` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations). ## OpenAPI specification Download the OpenAPI definition: https://api.apify.com/v2/actors/pUyUofhohKGOQ9rAu/builds/w3AOyM62ZMAA3NSCG/openapi.json