The Pismo Developers Portal provides comprehensive documentation to help you integrate services from the Pismo platform, Pismo’s cloud-native all-in-one processing platform for banking and payments, into your applications. It brings together detailed product guides, a REST API reference, JSON event schemas, and a monthly changelog, all in one place.

Who is it for?

The Developers Portal supports the following teams and processes:

• Developers building integrations using Pismo APIs
• Solution architects planning service implementations
• Technical and operations teams managing configurations and monitoring platform changes
• Product teams exploring the capabilities of the Pismo platform

Why use it?

The Developers Portal consolidates all technical information required for you to understand and use the Pismo platform, and provides key use cases, including the ability to:

• Access the most up-to-date API reference documentation for all Pismo solutions.
• Learn about Pismo’s offerings, and how to implement them, through comprehensive guides.
• Explore Pismo's data event library and find out how to configure real-time and batch event processing.
• Familiarize yourself with Control Center, Pismo’s interactive user interface for configuring your integrations.
• Track platform updates and service deprecations through the monthly changelog.

How is it organized?

The Developers Portal is organized into four high-level sections:

• Guides
• APIs
• Events
• Changelog

Guides

The Guides section provides comprehensive product documentation, including conceptual overviews and step-by-step guidance, for building your products using the Pismo platform. The guides are organized by core platform, data and reporting, and product solutions.

To learn more about Pismo's main solutions, explore the following guides.

Card issuing

Issue and manage a variety of card types, including debit, credit, prepaid, white-label, and private-label cards.

Core banking

Integrate your choice of Pismo's core banking capabilities, including accounts, balance tracking, interest-bearing products, and instant payment, with your products and services.

Digital lending

Create personal and Buy Now Pay Later (BNPL) loan products, and configure disbursement and repayment options across the full loan lifecycle.

Digital wallets

Tokenize and provision payment cards securely through Pismo's tokenization endpoints for use in digital wallets and token-based payment solutions.

Control Center

Build and manage your payment and banking programs on the Pismo platform through Control Center's interactive user interface.

Seller management

Manage online and point-of-sale merchant and marketplace processes.

Use the guides when you need to do the following:

• Understand platform concepts and workflows.
• Learn how to integrate and configure Pismo solutions with your applications.
• Explore domain-specific features before diving into the APIs.

APIs

The APIs section contains Pismo’s API reference, an extensive RESTful API library with more than 600 integration endpoints. It's organized by product and functionality.

Each endpoint includes the following common items:

• The endpoint URL
• A description of the endpoint and its purpose
• A list of the accepted parameters
• A list of the accepted headers
• A list of possible responses
• An interactive ‘try it yourself’ console for testing API calls directly, in real time, from the Developers Portal itself

📘

Pismo Postman collection

For a more customizable and streamlined approach to testing Pismo APIs, Pismo provides a ready-to-use Postman API collection.

For more information, refer to Test Pismo APIs with Postman.

Use this section when you need to do the following:

• Integrate Pismo API endpoints with your applications.
• Understand request and response structures.
• Test API calls using the interactive console.

Events

The Events section is a dedicated space for Pismo data events. The Pismo platform is built on an event-driven architecture, where data events give you real-time visibility into what’s happening across your financial operations. Each event represents a specific action, for example, a payment, account update, or settlement, and includes detailed data useful for reporting and analytics.

Data events are delivered in JSON format, and you can choose to receive events in real time or as batch file deliveries, depending on your specific internal data workflows.

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Overdraft product created",
    "description": "Create an organization's overdraft product.",
    "required": [
        "product_id",
        "name",
        "interest_plan_id",
        "processing_codes",
        "status",
        "created_at"
    ],
    "properties": {
        "product_id": {
            "type": "string",
            "title": "Product ID",
            "description": "Product ID on the Pismo platform. The ID is in the UUID v4 format.",
            "examples": [
                "2c336e9d-d04f-4fd0-8f6e-25808f48d70c"
            ]
        },
        "name": {
            "type": "string",
            "title": "Product name",
            "description": "Name of the overdraft product",
            "examples": [
                "Tax 1 Default"
            ]
        },
        "interest_plan_id": {
            "type": "string",
            "title": "Interest plan ID",
            "description": "Your interest plan ID on the Pismo platform. Displayed in the UUID v4 format.",
            "examples": [
                "b935acaf-886c-4817-8f7c-c2cc3ce4d509"
            ]
        },
        "processing_codes": {
            "type": "object",
            "title": "Processing codes",
            "description": "Accounting processing codes",
            "required": [
                "interest_processing_code"
            ],
            "properties": {
                "interest_processing_code": {
                    "type": "string",
                    "title": "Interest processing code",
                    "description": "Processing code used to identify interest-related transactions such as interest accrual, charging, and reversals on the overdraft balance.",
                    "examples": [
                        "202526"
                    ]
                }
            }
        },
        "status": {
            "type": "string",
            "title": "Status",
            "description": "Overdraft product status. The status of a new product's status is always `CREATED`.",
            "examples": [
                "CREATED"
            ]
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Product creation datetime",
            "description": "Overdraft product creation datetime. Represented as an RFC3339 timestamp.",
            "examples": [
                "2024-01-23T13:26:25"
            ]
        },
        "grace_period": {
            "type": "integer",
            "title": "Grace period",
            "description": "Grace period in days.",
            "examples": [
                0
            ]
        }
    }
}

{
    "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
    "name": "Tax 1 Default",
    "interest_plan_id": "b935acaf-886c-4817-8f7c-c2cc3ce4d509",
    "processing_codes": {
        "interest_processing_code": "202526"
    },
    "status": "CREATED",
    "created_at": "2024-01-23T13:26:25",
    "grace_period": 0
}

For more information, refer to Data events and Data and reporting overview.

Use this section when you need to do the following:

• Understand the format and structure of data events.
• Validate event-specific data.
• Reference data event schemas for integration with your internal reporting and analytics programs.

Changelog

The Changelog section notifies you about new features, updates, and service deprecations on the Pismo platform, the Developers Portal, and Control Center. It's updated monthly.

Use this section when you need to do the following:

• Track platform changes that might affect your integrations and configurations.
• Plan for upcoming service deprecations.

How do I find what I need?

The Developers Portal includes a built-in AI search feature to help you navigate the portal and answer your questions. For more information, refer to Get started with AI-powered search.

How do I contact Pismo?

Pismo is committed to maintaining high-quality, comprehensive documentation, and we welcome your input. To share your feedback, you can do either of the following:

• Open a Service Desk request and select the Projects request type.
• Leave a comment using the Did this page help you? feedback widget, located at the bottom of all pages in Guides and APIs.

If you're experiencing issues with the Pismo platform, the Pismo Service Desk is here to help. For more information, refer to Support.