# Pismo - Guides and APIs Documentation > Reference and guidance content for developers using the Pismo platform. ## Guides - [Get started with the Pismo Developers Portal](https://developers.pismo.io/pismo-docs/docs/welcome.md) - [Get started with Ask AI](https://developers.pismo.io/pismo-docs/docs/get-started-with-ask-ai.md) - [Start building](https://developers.pismo.io/pismo-docs/docs/start-building.md) - [Onboarding for new customers](https://developers.pismo.io/pismo-docs/docs/pismo-platform-onboarding.md) - [Get started with Control Center ](https://developers.pismo.io/pismo-docs/docs/get-started-building-control-center.md) - [Get started with banking ](https://developers.pismo.io/pismo-docs/docs/get-started-building-banking.md) - [Get started with core banking ](https://developers.pismo.io/pismo-docs/docs/get-started-building-core-banking.md) - [Get started with transaction banking](https://developers.pismo.io/pismo-docs/docs/get-started-building-transaction-banking.md) - [Get started with demand deposit accounts (DDAs) ](https://developers.pismo.io/pismo-docs/docs/get-started-building-demand-deposit-accounts.md) - [Get started with card issuing ](https://developers.pismo.io/pismo-docs/docs/get-started-building-card-issuing.md) - [Get started with lending ](https://developers.pismo.io/pismo-docs/docs/get-started-building-lending.md) - [Get started with Seller management ](https://developers.pismo.io/pismo-docs/docs/get-started-building-seller-management.md) - [Learn about the Pismo platform ](https://developers.pismo.io/pismo-docs/docs/pismo-platform-overview.md) - [Main solutions](https://developers.pismo.io/pismo-docs/docs/main-solutions.md) - [Core objects](https://developers.pismo.io/pismo-docs/docs/setup-overview.md) - [Program types](https://developers.pismo.io/pismo-docs/docs/program-types.md) - [Environments](https://developers.pismo.io/pismo-docs/docs/environments.md) - [Data events](https://developers.pismo.io/pismo-docs/docs/event-data.md) - [Security](https://developers.pismo.io/pismo-docs/docs/security.md) - [Security guide for Pismo platform](https://developers.pismo.io/pismo-docs/docs/pismo-platform-security-guide.md) - [Security audit, testing, and incident response](https://developers.pismo.io/pismo-docs/docs/security-audit-testing-and-incident-response.md) - [Compliance, certifications, and security teams](https://developers.pismo.io/pismo-docs/docs/certifications-compliance-and-security-teams.md) - [Security guide for APIs](https://developers.pismo.io/pismo-docs/docs/security-guide-for-apis.md) - [Security guide for Control Center](https://developers.pismo.io/pismo-docs/docs/security-guide-for-control-center.md) - [Basic authentication with client credentials](https://developers.pismo.io/pismo-docs/docs/basic-authentication-with-client-credentials.md) - [Authentication with OpenID Connect](https://developers.pismo.io/pismo-docs/docs/authentication-with-openid.md) - [Authentication with OAuth2](https://developers.pismo.io/pismo-docs/docs/authentication-with-oauth2.md) - [Third-party authentication](https://developers.pismo.io/pismo-docs/docs/third-party-authentication-with-openid.md) - [Identity connectivity with mTLS](https://developers.pismo.io/pismo-docs/docs/identity-connectivity-with-mtls.md) - [Verifying webhook requests](https://developers.pismo.io/pismo-docs/docs/verifying-webhook-requests.md) - [Support](https://developers.pismo.io/pismo-docs/docs/support.md) - [Pismo operations status](https://developers.pismo.io/pismo-docs/docs/pismo-operations-status.md) - [Pismo platform sub-processors](https://developers.pismo.io/pismo-docs/docs/pismo-platform-sub-processors.md) - [Pismo Service Desk](https://developers.pismo.io/pismo-docs/docs/service-desk.md) - [Request access to Pismo resources](https://developers.pismo.io/pismo-docs/docs/requests-for-access.md) - [Request types and common fields](https://developers.pismo.io/pismo-docs/docs/request-types.md) - [Open a service request](https://developers.pismo.io/pismo-docs/docs/opening-a-service-desk-ticket.md) - [Describe the issue](https://developers.pismo.io/pismo-docs/docs/describing-an-issue.md) - [Incident lifecycle](https://developers.pismo.io/pismo-docs/docs/incident-lifecycle.md) - [Non-incident lifecycle](https://developers.pismo.io/pismo-docs/docs/non-incident-lifecycle.md) - [Track a service request](https://developers.pismo.io/pismo-docs/docs/track-a-service-request.md) - [Modify a service request](https://developers.pismo.io/pismo-docs/docs/modify-a-service-request.md) - [Request a performance test](https://developers.pismo.io/pismo-docs/docs/requesting-a-performance-test.md) - [Pismo API testing overview ](https://developers.pismo.io/pismo-docs/docs/pismo-api-testing-overview.md) - [Access Pismo OpenAPI files on GitHub](https://developers.pismo.io/pismo-docs/docs/access-pismo-openapi-files-on-github.md) - [Access Pismo Postman collections](https://developers.pismo.io/pismo-docs/docs/access-pismo-postman-collections.md) - [API lifecycle and deprecation strategy](https://developers.pismo.io/pismo-docs/docs/api-deprecation-strategy.md) - [API endpoint deprecation and removal schedule](https://developers.pismo.io/pismo-docs/docs/api-endpoint-deprecation-and-removal-schedule.md) - [API endpoints removed](https://developers.pismo.io/pismo-docs/docs/api-endpoints-removed.md) - [Use LLMs with the Pismo Developers Portal](https://developers.pismo.io/pismo-docs/docs/use-llms-with-pismo-developers-portal.md) - [Pismo changelog](https://developers.pismo.io/pismo-docs/docs/pismo-changelog.md) - [Get started with Control Center](https://developers.pismo.io/pismo-docs/docs/get-started-with-control-center.md) - [Sign on to Control Center](https://developers.pismo.io/pismo-docs/docs/get-access-and-sign-on.md) - [Navigate Control Center](https://developers.pismo.io/pismo-docs/docs/control-center-navigation.md) - [Control Center security](https://developers.pismo.io/pismo-docs/docs/security-for-control-center.md) - [Best practices for Control Center passwords](https://developers.pismo.io/pismo-docs/docs/cc-pw-best-practices.md) - [Reset your password](https://developers.pismo.io/pismo-docs/docs/password-self-reset-control-center.md) - [Get started with SSO for Control Center](https://developers.pismo.io/pismo-docs/docs/get-started-with-sso-for-control-center.md) - [Add additional methods for multi-factor authentication (MFA)](https://developers.pismo.io/pismo-docs/docs/add-methods-for-mfa.md) - [Platform configurations](https://developers.pismo.io/pismo-docs/docs/platform-configurations.md) - [Balance configurations in Control Center](https://developers.pismo.io/pismo-docs/docs/balance-configurations-in-control-center.md) - [Edit an existing balance configuration](https://developers.pismo.io/pismo-docs/docs/edit-an-existing-balance-configuration.md) - [Holidays](https://developers.pismo.io/pismo-docs/docs/holidays.md) - [Exchange rates in Control Center](https://developers.pismo.io/pismo-docs/docs/exchange-rates.md) - [Fee models in Control Center](https://developers.pismo.io/pismo-docs/docs/fee-models-in-control-center.md) - [Manage fees in a fee model](https://developers.pismo.io/pismo-docs/docs/add-a-fee-to-a-fee-model.md) - [Link a fee model](https://developers.pismo.io/pismo-docs/docs/attach-a-fee-model.md) - [Flex controls](https://developers.pismo.io/pismo-docs/docs/cc-flex-controls.md) - [Example: Create a flex control for Pix transactions](https://developers.pismo.io/pismo-docs/docs/example-create-a-flex-control-for-pix-transactions.md) - [General ledger accounts](https://developers.pismo.io/pismo-docs/docs/cc-general-ledger-accounts.md) - [Processing codes and transaction types](https://developers.pismo.io/pismo-docs/docs/cc-manage-processing-codes-and-transaction-types.md) - [Create processing codes and transaction types](https://developers.pismo.io/pismo-docs/docs/create-processing-codes-and-transaction-types.md) - [Add a transaction type to an existing processing code](https://developers.pismo.io/pismo-docs/docs/add-a-transaction-type-to-an-existing-processing-code.md) - [Programs](https://developers.pismo.io/pismo-docs/docs/cc-manage-programs.md) - [Create a program from a template](https://developers.pismo.io/pismo-docs/docs/add-a-program-from-a-template.md) - [Export and import a program](https://developers.pismo.io/pismo-docs/docs/export-and-import-a-program.md) - [Clone a program](https://developers.pismo.io/pismo-docs/docs/clone-a-program.md) - [Cloned and imported program properties](https://developers.pismo.io/pismo-docs/docs/cc-cloned-and-exported-data.md) - [Edit programs](https://developers.pismo.io/pismo-docs/docs/cc-manage-program-details-and-parameters.md) - [Enable card issuing](https://developers.pismo.io/pismo-docs/docs/cc-enable-card-issuing.md) - [Card configurations](https://developers.pismo.io/pismo-docs/docs/cards-configurations.md) - [Card network tokenization](https://developers.pismo.io/pismo-docs/docs/card-network-tokenization.md) - [Embossing ](https://developers.pismo.io/pismo-docs/docs/embossing-in-control-center.md) - [Transaction categories](https://developers.pismo.io/pismo-docs/docs/cc-manage-transaction-categories.md) - [Banking configurations](https://developers.pismo.io/pismo-docs/docs/banking-configurations.md) - [Deposit products](https://developers.pismo.io/pismo-docs/docs/deposit-products-in-control-center.md) - [Add a time deposit product](https://developers.pismo.io/pismo-docs/docs/add-a-time-deposit-product.md) - [Add a savings account product](https://developers.pismo.io/pismo-docs/docs/add-a-savings-account-product.md) - [Interest plans](https://developers.pismo.io/pismo-docs/docs/interest-plans-in-control-center.md) - [Lending configurations](https://developers.pismo.io/pismo-docs/docs/digital-lending.md) - [Loan products](https://developers.pismo.io/pismo-docs/docs/loan-products-cc.md) - [Customer operations](https://developers.pismo.io/pismo-docs/docs/customer-operations.md) - [Account management](https://developers.pismo.io/pismo-docs/docs/accounts-management-in-control-center.md) - [Accounts overview](https://developers.pismo.io/pismo-docs/docs/accounts-overview-cc.md) - [Account actions](https://developers.pismo.io/pismo-docs/docs/account-actions.md) - [Attach an account to a deposit product](https://developers.pismo.io/pismo-docs/docs/attach-an-account-to-a-deposit-product.md) - [Card information](https://developers.pismo.io/pismo-docs/docs/card-information.md) - [Manage loans in Control Center](https://developers.pismo.io/pismo-docs/docs/manage-loans-in-control-center.md) - [Account configurations](https://developers.pismo.io/pismo-docs/docs/account-configurations-in-control-center.md) - [Disputes](https://developers.pismo.io/pismo-docs/docs/disputes.md) - [Users](https://developers.pismo.io/pismo-docs/docs/users.md) - [Audit](https://developers.pismo.io/pismo-docs/docs/view-user-activity-audit.md) - [Dual approval](https://developers.pismo.io/pismo-docs/docs/dual-approval.md) - [User profiles](https://developers.pismo.io/pismo-docs/docs/users-and-permissions-in-control-center.md) - [Create and edit users](https://developers.pismo.io/pismo-docs/docs/add-a-user.md) - [Export user list](https://developers.pismo.io/pismo-docs/docs/export-user-list.md) - [User permissions and roles](https://developers.pismo.io/pismo-docs/docs/control-center-access-profiles-and-roles.md) - [Permissions](https://developers.pismo.io/pismo-docs/docs/platform-authentication-in-control-center.md) - [Access keys](https://developers.pismo.io/pismo-docs/docs/access-keys-for-basic-authentication.md) - [OpenID Connect](https://developers.pismo.io/pismo-docs/docs/openid-configurations.md) - [Permission groups](https://developers.pismo.io/pismo-docs/docs/cc-api-permission-groups.md) - [Seller management](https://developers.pismo.io/pismo-docs/docs/seller-management-in-control-center.md) - [Accounts](https://developers.pismo.io/pismo-docs/docs/accounts-overview.md) - [Account limits](https://developers.pismo.io/pismo-docs/docs/working-with-limits-objects.md) - [Program parameters](https://developers.pismo.io/pismo-docs/docs/program-parameters-reference-table.md) - [Account parameters](https://developers.pismo.io/pismo-docs/docs/account-parameters-reference-table.md) - [Program limits](https://developers.pismo.io/pismo-docs/docs/program-limits.md) - [Processing codes](https://developers.pismo.io/pismo-docs/docs/processing-codes-and-transaction-types.md) - [Payments configurations](https://developers.pismo.io/pismo-docs/docs/payments-configurations.md) - [Transaction types](https://developers.pismo.io/pismo-docs/docs/transactiontypes.md) - [Transactions overview](https://developers.pismo.io/pismo-docs/docs/transactions-overview.md) - [Payment methods overview](https://developers.pismo.io/pismo-docs/docs/payment-methods-overview.md) - [Payment methods](https://developers.pismo.io/pismo-docs/docs/payment-methods.md) - [Payment methods configurations overview](https://developers.pismo.io/pismo-docs/docs/payment-configurations.md) - [Configure payment methods](https://developers.pismo.io/pismo-docs/docs/configure-payment-methods.md) - [Authorization validation rules for platform operations](https://developers.pismo.io/pismo-docs/docs/authorization-validation-rules-for-platform-operations.md) - [Payments and transfers](https://developers.pismo.io/pismo-docs/docs/payments.md) - [How to make transfer](https://developers.pismo.io/pismo-docs/docs/make-transfer.md) - [How to cancel transfer](https://developers.pismo.io/pismo-docs/docs/cancel-transfer.md) - [Force operation](https://developers.pismo.io/pismo-docs/docs/force-operation.md) - [Hold funds](https://developers.pismo.io/pismo-docs/docs/hold-funds.md) - [Payment requests](https://developers.pismo.io/pismo-docs/docs/payment-requests.md) - [Installments payment](https://developers.pismo.io/pismo-docs/docs/installments-payment.md) - [Payment scheduler](https://developers.pismo.io/pismo-docs/docs/payment-scheduler.md) - [Legal blocks (outdated)](https://developers.pismo.io/pismo-docs/docs/legal-blocks.md) - [Client webhooks](https://developers.pismo.io/pismo-docs/docs/client-webhooks.md) - [Client webhooks for VCAS](https://developers.pismo.io/pismo-docs/docs/vcas-client-webhooks.md) - [Platform setup - Holidays and administrative divisions](https://developers.pismo.io/pismo-docs/docs/platform-setup-holidays.md) - [Flexible transaction controls](https://developers.pismo.io/pismo-docs/docs/flex-controls.md) - [Attribute groups](https://developers.pismo.io/pismo-docs/docs/attribute-groups.md) - [Fee models](https://developers.pismo.io/pismo-docs/docs/fee-models.md) - [Creating and applying fee models](https://developers.pismo.io/pismo-docs/docs/create-fee-model.md) - [IOF fee model for Brazil](https://developers.pismo.io/pismo-docs/docs/iof-fee-model.md) - [Simulating and testing fee models](https://developers.pismo.io/pismo-docs/docs/simulating-fee-models.md) - [Over-limit fees](https://developers.pismo.io/pismo-docs/docs/over-limit-fee.md) - [Exchange rates](https://developers.pismo.io/pismo-docs/docs/exchange-rate.md) - [Accounting overview](https://developers.pismo.io/pismo-docs/docs/accounting-overview.md) - [Search for accounting event types](https://developers.pismo.io/pismo-docs/docs/search-for-accounting-event-types.md) - [How to create accounting entries](https://developers.pismo.io/pismo-docs/docs/create-accounting-entries.md) - [How to create accounting script](https://developers.pismo.io/pismo-docs/docs/create-an-accounting-script.md) - [How to create accounting account](https://developers.pismo.io/pismo-docs/docs/create-an-accounting-account.md) - [Accounting scripts examples](https://developers.pismo.io/pismo-docs/docs/accounting-scripts-examples.md) - [Accounting events](https://developers.pismo.io/pismo-docs/docs/accounting-events.md) - [Migrations](https://developers.pismo.io/pismo-docs/docs/migrations-overview.md) - [Balance configurations overview](https://developers.pismo.io/pismo-docs/docs/balances-configurations-overview.md) - [Balance configuration use cases](https://developers.pismo.io/pismo-docs/docs/balance-configuration-use-cases.md) - [Balance configuration filter templates](https://developers.pismo.io/pismo-docs/docs/filter-templates.md) - [Simulation service](https://developers.pismo.io/pismo-docs/docs/simulation-service.md) - [Data and reporting overview](https://developers.pismo.io/pismo-docs/docs/data-reporting-overview.md) - [Event-generating APIs](https://developers.pismo.io/pismo-docs/docs/data-events.md) - [Core platform - Accounting](https://developers.pismo.io/pismo-docs/docs/accounting-data-events.md) - [Core platform - Accounts](https://developers.pismo.io/pismo-docs/docs/accounts-data-events.md) - [Core platform - Flex controls](https://developers.pismo.io/pismo-docs/docs/flex-controls-data-events.md) - [Core platform - Balance configurations](https://developers.pismo.io/pismo-docs/docs/balance-configurations-data-events.md) - [Core platform - Ledger](https://developers.pismo.io/pismo-docs/docs/ledger-data-events.md) - [Core platform - Payments](https://developers.pismo.io/pismo-docs/docs/payments-data-events.md) - [Core platform - Transactions](https://developers.pismo.io/pismo-docs/docs/transactions-data-events.md) - [Card issuing - Disputes](https://developers.pismo.io/pismo-docs/docs/disputes-endpoint-generated-events.md) - [Card issuing - Cards](https://developers.pismo.io/pismo-docs/docs/cards-data-events.md) - [Revolving credit - Delinquent account](https://developers.pismo.io/pismo-docs/docs/delinquency-account-data-events.md) - [Revolving credit - Delinquency](https://developers.pismo.io/pismo-docs/docs/delinquency-buckets-data-events.md) - [Revolving credit - Recurring charges](https://developers.pismo.io/pismo-docs/docs/recurring-charges-data-events.md) - [Revolving credit - Statements](https://developers.pismo.io/pismo-docs/docs/statement-data-events.md) - [Banking - Assets](https://developers.pismo.io/pismo-docs/docs/assets-data-events.md): This table lists the asset endpoints and the events they generate. For information on setting up event notifications, see the [Data and reporting overview](doc:data-reporting-overview). - [Banking - Bank accounts](https://developers.pismo.io/pismo-docs/docs/international-bank-accounts-data-events.md) - [Banking - Credit receivables](https://developers.pismo.io/pismo-docs/docs/depositary-data-events.md) - [Banking - Integrated payments](https://developers.pismo.io/pismo-docs/docs/bank-slips-data-events.md) - [Banking - Interest management](https://developers.pismo.io/pismo-docs/docs/interest-management-data-events.md) - [Instant payments - Faster Payments](https://developers.pismo.io/pismo-docs/docs/faster-payments-events.md) - [Instant payments - Pix](https://developers.pismo.io/pismo-docs/docs/pix-payments-data-events.md) - [Migrations events](https://developers.pismo.io/pismo-docs/docs/migrations-data-events.md) - [Seller management - Marketplace](https://developers.pismo.io/pismo-docs/docs/marketplace-data-events.md) - [Seller management - Merchant advance](https://developers.pismo.io/pismo-docs/docs/merchant-advancements-data-events.md) - [Seller management - Merchants](https://developers.pismo.io/pismo-docs/docs/merchants-data-events.md) - [Lending events](https://developers.pismo.io/pismo-docs/docs/lending-data-events.md) - [Timeline events](https://developers.pismo.io/pismo-docs/docs/timeline-overview.md) - [Setting up real-time event delivery](https://developers.pismo.io/pismo-docs/docs/setting-up-real-time-event-delivery.md) - [AWS SNS event configuration tutorial](https://developers.pismo.io/pismo-docs/docs/aws-event-tutorial.md) - [AWS EventBridge event configuration tutorial](https://developers.pismo.io/pismo-docs/docs/aws-eventbridge-event-configuration-tutorial.md) - [GCP event configuration tutorial](https://developers.pismo.io/pismo-docs/docs/gcp-event-configuration-tutorial.md) - [Azure event configuration tutorial](https://developers.pismo.io/pismo-docs/docs/azure-event-configuration-tutorial.md) - [Confluent event configuration tutorial](https://developers.pismo.io/pismo-docs/docs/confluent-event-config-tutorial.md) - [Setting up event batch file delivery](https://developers.pismo.io/pismo-docs/docs/setting-up-event-file-delivery.md) - [AWS event file configuration tutorial](https://developers.pismo.io/pismo-docs/docs/aws-event-file-configuration-tutorial.md) - [GCP event file configuration tutorial](https://developers.pismo.io/pismo-docs/docs/gcp-event-file-configuration-tutorial.md) - [SFTP event file configuration tutorial](https://developers.pismo.io/pismo-docs/docs/sftp-event-file-configuration-tutorial.md) - [Setting up an additional event subscriber](https://developers.pismo.io/pismo-docs/docs/setting-up-an-additional-subscriber.md) - [Setting up event filtering](https://developers.pismo.io/pismo-docs/docs/event-filtering.md) - [Data events recovery](https://developers.pismo.io/pismo-docs/docs/data-events-recovery.md) - [Scheduled reports](https://developers.pismo.io/pismo-docs/docs/scheduled-reports.md) - [Base scheduled reports](https://developers.pismo.io/pismo-docs/docs/base-scheduled-reports.md) - [Accounting events report files](https://developers.pismo.io/pismo-docs/docs/accounting-events-report-files.md) - [Accounts analytic report files](https://developers.pismo.io/pismo-docs/docs/accounts-analytic-report-files.md) - [Account balances report files](https://developers.pismo.io/pismo-docs/docs/accounts-balances-report-files.md) - [Account limits report files](https://developers.pismo.io/pismo-docs/docs/account-limits-report-files-v2.md) - [Billing report files](https://developers.pismo.io/pismo-docs/docs/billing-report-files.md) - [Discharge tracking report files](https://developers.pismo.io/pismo-docs/docs/discharge-tracking-report-files.md) - [Portfolio balance report files](https://developers.pismo.io/pismo-docs/docs/portfolio-balance-report-files.md) - [Transactions balance report files](https://developers.pismo.io/pismo-docs/docs/transactions-balance-report-files.md) - [Transactions denied report files](https://developers.pismo.io/pismo-docs/docs/transactions-denied.md) - [Regulatory scheduled reports](https://developers.pismo.io/pismo-docs/docs/regulatory-scheduled-reports.md) - [Reports for Brazil](https://developers.pismo.io/pismo-docs/docs/brazilian-reports.md) - [Reports for the United States](https://developers.pismo.io/pismo-docs/docs/reports-for-the-united-states.md) - [Pismo data platform – HTTP integration guide (beta)](https://developers.pismo.io/pismo-docs/docs/pismo-data-platform-http-integration-guide-beta.md) - [Banking overview](https://developers.pismo.io/pismo-docs/docs/banking-overview.md) - [Get started with core banking](https://developers.pismo.io/pismo-docs/docs/get-started-with-core-banking.md) - [Transaction banking](https://developers.pismo.io/pismo-docs/docs/corporate-banking-overview.md) - [Get started with transaction banking](https://developers.pismo.io/pismo-docs/docs/get-started-with-transaction-banking.md) - [Get started with demand deposit accounts (DDAs)](https://developers.pismo.io/pismo-docs/docs/corporate-banking-launch-reference.md) - [Transaction banking accounts](https://developers.pismo.io/pismo-docs/docs/corporate-accounts.md) - [Payment overview](https://developers.pismo.io/pismo-docs/docs/payment-overview.md) - [Check posting and settlement](https://developers.pismo.io/pismo-docs/docs/check-posting-and-settlement.md) - [File-based check processing and bulk settlement](https://developers.pismo.io/pismo-docs/docs/file-based-check-processing-and-bulk-settlement.md) - [Channel control for back-business-date and cutoff exceptions](https://developers.pismo.io/pismo-docs/docs/channel-control-for-back-business-date-and-cutoff-exceptions.md) - [Banking as a Service](https://developers.pismo.io/pismo-docs/docs/banking-as-a-service.md) - [Hierarchies](https://developers.pismo.io/pismo-docs/docs/hierarchies-2.md) - [Divisions](https://developers.pismo.io/pismo-docs/docs/divisions.md) - [Calendars and holidays in transaction banking](https://developers.pismo.io/pismo-docs/docs/calendars-and-holidays-in-transaction-banking.md) - [Manage account statuses](https://developers.pismo.io/pismo-docs/docs/managing-account-statuses.md) - [Dormancy overview](https://developers.pismo.io/pismo-docs/docs/dormancy-overview.md) - [Restriction management](https://developers.pismo.io/pismo-docs/docs/restriction-management.md) - [Dormancy reactivation exception](https://developers.pismo.io/pismo-docs/docs/dormancy-reactivation-exception.md) - [Interest-bearing accounts](https://developers.pismo.io/pismo-docs/docs/interest-bearing-accounts.md) - [Penalties for CD accounts](https://developers.pismo.io/pismo-docs/docs/penalties-for-cd-accounts.md) - [How overdraft works](https://developers.pismo.io/pismo-docs/docs/how-overdraft-works.md) - [Funds coverage](https://developers.pismo.io/pismo-docs/docs/funds-coverage.md) - [Account balance definitions for transaction banking](https://developers.pismo.io/pismo-docs/docs/account-balance-definitions-for-transaction-banking.md) - [Bank statements](https://developers.pismo.io/pismo-docs/docs/bank-statements-1.md) - [Single ledger entries and book transfers](https://developers.pismo.io/pismo-docs/docs/single-ledger-entries-and-book-transfers.md): Use the Post payment API to create single ledger entries and book transfers. - [Business-dated transactions](https://developers.pismo.io/pismo-docs/docs/biz-dated-txns.md) - [Back-business-dated transactions](https://developers.pismo.io/pismo-docs/docs/back-biz-dated-txns.md) - [Future-business-dated transactions](https://developers.pismo.io/pismo-docs/docs/future-biz-dated-txns.md) - [Back-value-dated transactions](https://developers.pismo.io/pismo-docs/docs/back-value-dated-txns.md) - [Future-value-dated transactions](https://developers.pismo.io/pismo-docs/docs/future-value-dated-txns.md) - [Multi-leg payments](https://developers.pismo.io/pismo-docs/docs/multi-leg-payments.md) - [Bulk file-based payment processing](https://developers.pismo.io/pismo-docs/docs/bulk-file-based-payment-processing.md) - [File signature and encryption](https://developers.pismo.io/pismo-docs/docs/file-signature-and-encryption.md) - [Schedule payment overview](https://developers.pismo.io/pismo-docs/docs/scheduled-payments.md) - [Posting transactions on holidays](https://developers.pismo.io/pismo-docs/docs/posting-transactions-on-holidays.md) - [Integrated payments](https://developers.pismo.io/pismo-docs/docs/integrated-payments.md) - [Instant payments](https://developers.pismo.io/pismo-docs/docs/instant-payments-overview.md) - [Pix instant payments (Brazil)](https://developers.pismo.io/pismo-docs/docs/pix-instant-payments.md) - [Pix and QR Codes](https://developers.pismo.io/pismo-docs/docs/pix-and-qr-codes.md) - [Pix Automatic](https://developers.pismo.io/pismo-docs/docs/pix-automatic.md) - [Pix funds recovery [beta]](https://developers.pismo.io/pismo-docs/docs/pix-funds-recovery.md) - [Faster Payments (UK)](https://developers.pismo.io/pismo-docs/docs/faster-payment-system.md) - [RuPay and UPI instant payments (India)](https://developers.pismo.io/pismo-docs/docs/united-payments-interface.md) - [Bank slips](https://developers.pismo.io/pismo-docs/docs/bank-slips.md) - [Bankers' Automated Clearing System ](https://developers.pismo.io/pismo-docs/docs/banking-automated-clearing-system.md) - [Earmarks](https://developers.pismo.io/pismo-docs/docs/earmarks.md) - [Operation block](https://developers.pismo.io/pismo-docs/docs/operation-block.md) - [Restrict funds](https://developers.pismo.io/pismo-docs/docs/restrict-funds.md) - [File-based processing](https://developers.pismo.io/pismo-docs/docs/file-based-processing.md) - [Get started with card issuing](https://developers.pismo.io/pismo-docs/docs/get-started-with-card-issuing.md) - [Step 1: Plan](https://developers.pismo.io/pismo-docs/docs/step-1-plan.md) - [Step 2: Establish a framework](https://developers.pismo.io/pismo-docs/docs/step-2-establish-a-framework.md) - [Step 3: Create your programs](https://developers.pismo.io/pismo-docs/docs/step-3-create-your-programs.md) - [Step 4: Create accounts and customers](https://developers.pismo.io/pismo-docs/docs/step-4-create-accounts-and-customers.md) - [Step 5: Create cards](https://developers.pismo.io/pismo-docs/docs/step-5-create-cards.md) - [Step 6: Test the integrated setup](https://developers.pismo.io/pismo-docs/docs/step-5-test.md) - [Step 7: Track performance and support users](https://developers.pismo.io/pismo-docs/docs/step-6-monitor.md) - [Card issuing reference](https://developers.pismo.io/pismo-docs/docs/card-issuing-basics.md) - [Card network certification](https://developers.pismo.io/pismo-docs/docs/network-certification.md) - [Cryptographic process with Pismo and the card network](https://developers.pismo.io/pismo-docs/docs/cryptographic-keys.md) - [Card network mandates](https://developers.pismo.io/pismo-docs/docs/card-network-mandates.md) - [Card network integration](https://developers.pismo.io/pismo-docs/docs/card-network-integration.md) - [Full balance versus Zero balance integration](https://developers.pismo.io/pismo-docs/docs/full-balance-versus-zero-balance.md) - [Full and Zero balance transaction workflows](https://developers.pismo.io/pismo-docs/docs/full-and-zero-balance-workflows.md) - [Clearing/Base II](https://developers.pismo.io/pismo-docs/docs/clearingbase.md) - [Anti-fraud integration](https://developers.pismo.io/pismo-docs/docs/anti-fraud-integration.md) - [Visa Consumer Authentication Service (VCAS)](https://developers.pismo.io/pismo-docs/docs/visa-consumer-authentication-service-vcas.md) - [PAN encryption for 3DS authentication](https://developers.pismo.io/pismo-docs/docs/pan-encryption-for-3ds-authentication.md) - [Zero balance anti-fraud and validations integration](https://developers.pismo.io/pismo-docs/docs/zero-balance-anti-fraud-integration-1.md) - [Authorization events](https://developers.pismo.io/pismo-docs/docs/authorization-events.md) - [Linking authorization events](https://developers.pismo.io/pismo-docs/docs/linking-events-in-an-authorization-workflow.md): Using events to map the life cycle of an authorization. - [Card network interchange fees](https://developers.pismo.io/pismo-docs/docs/card-network-interchange-fees.md) - [Validation codes for authorization events](https://developers.pismo.io/pismo-docs/docs/validation-codes-for-authorization-events.md) - [Validation code definitions](https://developers.pismo.io/pismo-docs/docs/validation-code-definitions.md) - [Authorization validation rules for card network operations](https://developers.pismo.io/pismo-docs/docs/authorization-validation-rules-for-card-network-operations.md) - [Rule list](https://developers.pismo.io/pismo-docs/docs/rule-list.md) - [Simulate authorizations](https://developers.pismo.io/pismo-docs/docs/simulate-authorizations.md): Walk-through of different scenarios to simulate authorizations. - [Replacement amount processing](https://developers.pismo.io/pismo-docs/docs/replacement-amount-processing.md) - [Incremental authorization](https://developers.pismo.io/pismo-docs/docs/incremental-authorization.md) - [Cards management](https://developers.pismo.io/pismo-docs/docs/cards-overview-1.md) - [Card lifecycle and statuses](https://developers.pismo.io/pismo-docs/docs/card-lifecycle-and-statuses.md) - [Card reissuing](https://developers.pismo.io/pismo-docs/docs/card-reissuing.md) - [Physical card embossing](https://developers.pismo.io/pismo-docs/docs/physical-card-embossing.md) - [Application Transaction Counter (ATC)](https://developers.pismo.io/pismo-docs/docs/application-transaction-counter-atc.md) - [PIN/PINBlock tutorial](https://developers.pismo.io/pismo-docs/docs/pinpinblock-tutorial.md) - [BIN override - shared account option](https://developers.pismo.io/pismo-docs/docs/bin-override-feature.md) - [Card scripts](https://developers.pismo.io/pismo-docs/docs/card-scripts.md) - [Protection Bulletin](https://developers.pismo.io/pismo-docs/docs/protection-bulletin.md) - [Visa Flexible Credentials [beta]](https://developers.pismo.io/pismo-docs/docs/visa-flexible-credentials.md) - [Automatic updater](https://developers.pismo.io/pismo-docs/docs/automatic-updater.md) - [Authorization configurations](https://developers.pismo.io/pismo-docs/docs/authorization-configurations-1.md) - [Run the configuration requests](https://developers.pismo.io/pismo-docs/docs/run-the-configuration-requests.md) - [Understanding statements](https://developers.pismo.io/pismo-docs/docs/understanding-statements.md) - [Holidays in credit card accounts](https://developers.pismo.io/pismo-docs/docs/holidays-in-credit-card-accounts.md) - [Credit cycle dates and time periods](https://developers.pismo.io/pismo-docs/docs/statement-cycle-dates.md) - [Calendar management strategies](https://developers.pismo.io/pismo-docs/docs/calendar-management-strategies.md) - [Fixed due date calendar management strategy](https://developers.pismo.io/pismo-docs/docs/fixed-due-date-calendars.md) - [Fixed cycle closing calendar management strategy](https://developers.pismo.io/pismo-docs/docs/fixed-cycle-closing-calendar-management-strategy.md) - [Monthly cycle closing calendar management strategy](https://developers.pismo.io/pismo-docs/docs/monthly-cycle-closing-calendar-management-strategy.md) - [Recurring charges](https://developers.pismo.io/pismo-docs/docs/recurring-charges.md) - [Minimum amount due calculation](https://developers.pismo.io/pismo-docs/docs/minimum-amount-due-calculation.md) - [Calculating interest accruals](https://developers.pismo.io/pismo-docs/docs/calculating-interest-accruals.md) - [Configuring accrual rates](https://developers.pismo.io/pismo-docs/docs/configuring-accrual-rates.md) - [How payments are applied to accruals](https://developers.pismo.io/pismo-docs/docs/how-payments-are-applied-to-accruals.md) - [Payment tolerance](https://developers.pismo.io/pismo-docs/docs/payment-tolerance.md) - [Overdue tolerance](https://developers.pismo.io/pismo-docs/docs/overdue-tolerance.md) - [Setting transaction types to block accrual charges](https://developers.pismo.io/pismo-docs/docs/configuring-transaction-types-to-not-accrue-charges.md) - [Limiting the number of days accruals can be charged](https://developers.pismo.io/pismo-docs/docs/limiting-the-number-of-days-accruals-can-be-charged.md) - [Projected accruals](https://developers.pismo.io/pismo-docs/docs/projected-accruals.md) - [Configuring a sellos tax](https://developers.pismo.io/pismo-docs/docs/configuring-a-sellos-tax.md) - [Multivalue program parameters](https://developers.pismo.io/pismo-docs/docs/multivalue-program-parameters.md) - [Delinquency buckets](https://developers.pismo.io/pismo-docs/docs/delinquency-buckets.md) - [Credit liquidation](https://developers.pismo.io/pismo-docs/docs/credit-liquidation.md) - [Accrual status changed event flows](https://developers.pismo.io/pismo-docs/docs/accrual-status-changed-event-flows.md) - [Account collection status](https://developers.pismo.io/pismo-docs/docs/account-collection-status.md) - [Credit card refinancing](https://developers.pismo.io/pismo-docs/docs/negotiating-credit-card-debt.md) - [Installment agreements](https://developers.pismo.io/pismo-docs/docs/installment-agreements.md) - [Installment advancements](https://developers.pismo.io/pismo-docs/docs/installment-advancements-guide.md) - [Statement agreements](https://developers.pismo.io/pismo-docs/docs/statement-agreements.md) - [Compulsory agreements](https://developers.pismo.io/pismo-docs/docs/compulsory-agreements.md) - [Transaction shifts](https://developers.pismo.io/pismo-docs/docs/transaction-shifts.md) - [Creating payment agreements with custom transactions](https://developers.pismo.io/pismo-docs/docs/creating-payment-agreements-with-custom-transactions.md) - [Disputes overview](https://developers.pismo.io/pismo-docs/docs/disputes-overview.md) - [Set up disputes access](https://developers.pismo.io/pismo-docs/docs/set-up-disputes.md) - [Disputes state machine](https://developers.pismo.io/pismo-docs/docs/disputes-state-machine.md) - [Visa collaboration and allocation questionnaires](https://developers.pismo.io/pismo-docs/docs/visa-colloboration-questionaire.md) - [Visa dispute use case](https://developers.pismo.io/pismo-docs/docs/visa-dispute-use-case.md) - [Digital wallets](https://developers.pismo.io/pismo-docs/docs/wallet-overview.md) - [Card tokenization process and onboarding](https://developers.pismo.io/pismo-docs/docs/card-tokenization-process-and-onboarding.md) - [Card tokenization flow and events](https://developers.pismo.io/pismo-docs/docs/card-tokenization-flow-and-events.md) - [Pismo card-on-file](https://developers.pismo.io/pismo-docs/docs/pismo-card-on-file.md) - [Click to Pay](https://developers.pismo.io/pismo-docs/docs/click-to-pay.md) - [MDES Token Connect [Beta]](https://developers.pismo.io/pismo-docs/docs/mdes-token-connect.md) - [Full balance credit program](https://developers.pismo.io/pismo-docs/docs/full-balance-credit-program.md) - [Discharging transactions](https://developers.pismo.io/pismo-docs/docs/discharging-transactions.md) - [Creating and configuring a Full balance credit program](https://developers.pismo.io/pismo-docs/docs/creating-and-configuring-a-full-balance-credit-program.md) - [Managing the charge order for debit transactions](https://developers.pismo.io/pismo-docs/docs/managing-the-charge-order-for-debit-transactions.md) - [Zero balance integration - issuer's guide](https://developers.pismo.io/pismo-docs/docs/zero-balance-integration.md) - [Lending overview](https://developers.pismo.io/pismo-docs/docs/lending-overview.md) - [Loan product overview](https://developers.pismo.io/pismo-docs/docs/loan-product-overview.md) - [Loan management overview](https://developers.pismo.io/pismo-docs/docs/loan-management-overview.md) - [Lending participants and responsibilities](https://developers.pismo.io/pismo-docs/docs/lending-participants-and-responsibilities.md) - [Loan statuses overview](https://developers.pismo.io/pismo-docs/docs/loan-statuses-overview.md) - [Get started with lending](https://developers.pismo.io/pismo-docs/docs/get-started-with-lending.md) - [Create loan products](https://developers.pismo.io/pismo-docs/docs/create-loan-products.md) - [Manage loans](https://developers.pismo.io/pismo-docs/docs/manage-loans.md) - [Simulate loans](https://developers.pismo.io/pismo-docs/docs/simulate-loans.md) - [Book loans](https://developers.pismo.io/pismo-docs/docs/book-a-loan.md) - [Disburse loans](https://developers.pismo.io/pismo-docs/docs/disburse-loan.md) - [Manage loan repayment and settlement](https://developers.pismo.io/pismo-docs/docs/manage-loan-repayment-and-settlement.md) - [Seller management overview](https://developers.pismo.io/pismo-docs/docs/seller-management-overview.md) - [Seller management onboarding](https://developers.pismo.io/pismo-docs/docs/seller-management-onboarding.md) - [Get started with Seller management](https://developers.pismo.io/pismo-docs/docs/get-started-with-seller-management.md) - [Step 1: Plan seller marketplaces](https://developers.pismo.io/pismo-docs/docs/step-1-plan-seller-marketplaces.md) - [Step 2. Create program for the marketplace](https://developers.pismo.io/pismo-docs/docs/step-2-create-program-marketplace.md) - [Step 3: Define processing codes](https://developers.pismo.io/pismo-docs/docs/step-3-define-processing-codes.md) - [Step 4: Running Seller marketplace operations](https://developers.pismo.io/pismo-docs/docs/step-4-running-marketplace-operations.md) - [Step 5: Test](https://developers.pismo.io/pismo-docs/docs/step-5-test-seller-marketplace.md) - [Step 6: Monitor](https://developers.pismo.io/pismo-docs/docs/step-6-monitor-seller-marketplace.md) - [Managing merchant transactions](https://developers.pismo.io/pismo-docs/docs/managing-merchant-transactions.md) - [How merchant settlements and installments are processed](https://developers.pismo.io/pismo-docs/docs/how-merchant-settlements-are-processed.md) ## API Reference - [Get started with Pismo APIs](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis.md) - [Rate limiting on the Pismo platform](https://developers.pismo.io/pismo-docs/reference/rate-limiting.md) - [Endpoints that require an account-specific token](https://developers.pismo.io/pismo-docs/reference/endpoints-that-require-an-account-specific-token.md) - [Endpoints that require an external account ID-specific token](https://developers.pismo.io/pismo-docs/reference/endpoints-that-require-an-external-id-token.md) - [Get OpenID access token](https://developers.pismo.io/pismo-docs/reference/post-passport-v1-oauth2-token.md): Get an access token for OpenID authentication A JSON Web Token (JWT) is a compact, URL-safe means of representing claims to be transferred between two parties. The JWT must be signed using the RS256 algorithm with your server's private key, and include specific claims as outlined in [Authentication with OpenID Connect](doc:authentication-with-openid). **Note**: Many of the endpoints in the Pismo API require you to pass a JWT that you generated which includes a Pismo account ID (`uid` or `account_id`) or an account ID from an external system used in place of the Pismo account ID (`external_account_id`). Further calls to Pismo endpoints will require this token in the Authorization header. For more information about account-specific tokens, refer to [Endpoints that require an account-specific token](ref:endpoints-that-require-an-account-specific-token) and [Endpoints that require an external ID-specific token](ref:endpoints-that-require-an-external-id-token). - [Get basic authentication access token](https://developers.pismo.io/pismo-docs/reference/post-passport-v2-s2s-access-token.md): Generate an access token for use with basic authentication.

For more information, refer to [Endpoints that require an account-specific token](ref:endpoints-that-require-an-account-specific-token) and [Endpoints that require an external ID-specific token](ref:endpoints-that-require-an-external-id-token). - [Update organization](https://developers.pismo.io/pismo-docs/reference/patch-v1-orgs.md): Performs a partial update of an organization's information. Fields not passed are not updated. - [Get organization](https://developers.pismo.io/pismo-docs/reference/get-v1-org.md): Returns information about a specific organization. - [Create holiday (deprecated)](https://developers.pismo.io/pismo-docs/reference/post-v1-orgs-holidays.md): **DEPRECATED**. Call the [Add holiday](https://developers.pismo.io/pismo-docs/reference/post-add-holiday-to-calendar) endpoint instead. Create a holiday. - [List holidays (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-v1-orgs-holidays.md): **DEPRECATED**. Call the new [List holidays](https://developers.pismo.io/pismo-docs/reference/get-holiday-new) endpoint instead. Retrieve a paginated list of holidays. - [Update holiday (deprecated)](https://developers.pismo.io/pismo-docs/reference/put-v1-orgs-holidays.md): **DEPRECATED**. Call the new [Uodate holiday](https://developers.pismo.io/pismo-docs/reference/update-holiday) endpoint instead. Update a holiday. - [Delete holiday (deprecated)](https://developers.pismo.io/pismo-docs/reference/delete-v1-orgs-holidays.md): **DEPRECATED**. Call the new [Delete holiday](https://developers.pismo.io/pismo-docs/reference/delete-holiday) instead. Delete a holiday. - [Create program](https://developers.pismo.io/pismo-docs/reference/createprogrambasedontemplate.md): Create a program synchronously. For more information about programs, refer to [Core objects](doc:setup-overview#program). This endpoint executes synchronously, meaning, a network timeout or similar network delay could occur. In this case, an error is generated. To avoid this possibility, call the [Create program (async)](ref:createprogrambasedontemplateasync) endpoint instead. Thie endpoint generates a [Program created](https://developers.pismo.io/events/docs/programs-creation-1) event. To get your Organization's programs, call the [List programs](ref:programs-1) endpoint, or view them in the [Pismo Control Center](doc:get-started-with-control-center). - [Create program (async)](https://developers.pismo.io/pismo-docs/reference/createprogrambasedontemplateasync.md): Create a program asynchronously. For more information about programs, refer to [Core objects](doc:setup-overview#program). This endpoint creates a program asynchronously; meaning, your app can continue executing during this. It could take 2 minutes or more for the platform to finish creating the program. Alternatively, you can use the [Create program](ref:createprogrambasedontemplate) endpoint, which executes synchronously and throws an error if the program cannot be created. This endpoint generates a [Program created](https://developers.pismo.io/events/docs/programs-creation-1) event. Given that creation is done asynchronously, it is recommended you do not try to access the program object via Pismo endpoints until this event is received. To get your Organization's programs, call the [List programs](ref:programs-1) endpoint, or view them in the [Pismo Control Center](doc:get-started-with-control-center). - [Copy program](https://developers.pismo.io/pismo-docs/reference/copyprogram.md): Copy an existing program to create a new one synchronously. For more information about programs, refer to [Core objects](doc:setup-overview#program). For information on what properties are copied, refer to [Cloned and exported program properties](doc:cc-cloned-and-exported-data). This endpoint executes synchronously; meaning, a network timeout or similar delay could occur. In this case, an error is generated. To avoid this possibility, call the [Copy program (async)](ref:copyprogramasync) endpoint instead. This endpoint generates a [Program created](https://developers.pismo.io/events/docs/programs-creation-1) event. To get your Organization's programs, call the [List programs](ref:programs-1) endpoint, or view them in the [Pismo Control Center](doc:get-started-with-control-center). - [Copy program (async)](https://developers.pismo.io/pismo-docs/reference/copyprogramasync.md): Copy an existing program to create a new one. Refer to [Core objects](doc:setup-overview) for more information about programs. For information on what properties are copied, refer to [Cloned and exported program properties](doc:cc-cloned-and-exported-data). This endpoint operates asynchronously; meaning, your program can continue executing while the program is being copied. It can take 2 minutes or more to copy the program. Alternatively, you can call [Copy program](ref:copyprogram), which executes synchronously and returns a response indicating failure or success. This endpoint generates a [Program created](https://developers.pismo.io/events/docs/programs-creation-1) event. Given that creation is done asynchronously, it is recommended you do not try to access the program object via Pismo endpoints until this event is received. To get your Organization's programs, call the [List programs](ref:programs-1) endpoint, or view them in the [Pismo Control Center](doc:get-started-with-control-center). - [List programs](https://developers.pismo.io/pismo-docs/reference/programs-1.md): List an organization's programs. The organization ID is parsed from the token. For information about programs and organizations, refer to [Core objects](doc:setup-overview). - [Get program V2](https://developers.pismo.io/pismo-docs/reference/program-2.md): Retrieve program details. - [Get program V1](https://developers.pismo.io/pismo-docs/reference/get-program-v1.md): Get details for a specific [program](doc:program-types). - [Update program](https://developers.pismo.io/pismo-docs/reference/updateprograminfo.md): Update a program. This endpoint generates a [Program updated](https://developers.pismo.io/events/docs/programs-update-1) event. **Note:** Due date is a **REQUIRED** field for [Full balance credit programs](doc:full-balance-credit-program) types. - [Link optional parameter to program](https://developers.pismo.io/pismo-docs/reference/createprogramparameter.md): Link an optional parameter to a program. Some program parameters are optional and not automatically linked to a program when it is created. For more information, refer to [Edit program details and parameters](doc:cc-manage-program-details-and-parameters) or the [Program parameters](doc:program-parameters-reference-table) reference table. - [List program parameters](https://developers.pismo.io/pismo-docs/reference/programparameter.md): Retrieves a paginated list of program parameters. - [Update program(s) parameters](https://developers.pismo.io/pismo-docs/reference/setprogramsparameters.md): Update program parameter values for one or more programs. For more information, refer to the [program parameters](doc:program-parameters-reference-table) reference table. - [Update program parameters](https://developers.pismo.io/pismo-docs/reference/setprogramparameters.md): Update one or more parameters for a specific program. For more information, refer to the [program parameters](doc:program-parameters-reference-table) reference table. - [Update program parameter](https://developers.pismo.io/pismo-docs/reference/updateprogramparameter.md): Update a program parameter value. For more information, refer to the [program parameters](doc:program-parameters-reference-table) reference table. - [List program parameters with localization](https://developers.pismo.io/pismo-docs/reference/programparameterv2.md): Get a paginated list of programs with localization parameters. Returns a `translation` object with language-specific parameter information. For information about programs, refer to [Core objects](doc:setup-overview#program). - [Export program](https://developers.pismo.io/pismo-docs/reference/postprogramexport.md): Export a program to a JSON file. While this endpoint returns an immediate response, it also kicks off an asynchronous export process. You can check its progress with the [Get program export record](ref:getprogramexportrecord) endpoint. When done, the program status changes to `SUCCESS`. To download the exported file, call [Download exported program](ref:getprogramexportdownload). - [List exported programs](https://developers.pismo.io/pismo-docs/reference/getprogramexport.md): Get your organization's exported programs in a paginated list. The organization ID is parsed from the token. - [Export programs](https://developers.pismo.io/pismo-docs/reference/postprogramexportbatch.md): Exports one or more programs to a ZIP file. This endpoint starts an async export process. When that process is done, the program status, for each exported program, changes to `SUCCESS`. To download the exported file, call the [Download exported program](ref:getprogramexportdownload) endpoint. - [Get program export record](https://developers.pismo.io/pismo-docs/reference/getprogramexportrecord.md): Gets a program's detailed export record, including the export steps and their statuses. - [Download exported program](https://developers.pismo.io/pismo-docs/reference/getprogramexportdownload.md): Download an exported program as a JSON file. Use this endpoint after exporting the program (using either [Export program](ref:postprogramexport) or [Export programs](ref:postprogramexportbatch). - [Import program](https://developers.pismo.io/pismo-docs/reference/postprogramimport.md): Uploads a JSON file to import a program. This endpoint generates a [Program created](https://developers.pismo.io/events/docs/programs-creation-1) event. - [List imported programs](https://developers.pismo.io/pismo-docs/reference/getprogramimport.md): Get your organization's imported programs in a paginated list. The org ID is parsed from the access token. - [Get program import record](https://developers.pismo.io/pismo-docs/reference/getprogramimportrecord.md): Get a detailed program import record, including the import steps and their statuses. - [Get program import record by program ID](https://developers.pismo.io/pismo-docs/reference/getprogramimportrecordbyid.md): Get a detailed programn import record, including the import steps and their statuses. - [Download imported program](https://developers.pismo.io/pismo-docs/reference/getprogramimportdownload.md): Download a previously imported program in JSON format. You can use this endpoint to review (audit) what program data was imported. If this call is via Postman, the JSON is returned in the response. In the Control Center, a browser dialog prompts you where to save the file. - [Create holiday calendar](https://developers.pismo.io/pismo-docs/reference/post-create-holiday-calendar.md): Creates a new holiday calendar with associated holidays. This endpoint does not generate an event. - [Update holiday calendar](https://developers.pismo.io/pismo-docs/reference/update-holiday-calendar.md): Update a holiday calendar. Fields not passed are not updated. - [Delete holiday calendar](https://developers.pismo.io/pismo-docs/reference/delete-holiday-calendar.md): Delete a holiday calendar - [Add holiday](https://developers.pismo.io/pismo-docs/reference/post-add-holiday-to-calendar.md): Add a new holiday to an existing holiday calendar. This endpoint generates a _______ event. - [Update holiday](https://developers.pismo.io/pismo-docs/reference/update-holiday.md): Update a holiday in a holiday calendar. - [Delete holiday](https://developers.pismo.io/pismo-docs/reference/delete-holiday.md): Delete a calendar holiday - [List holiday calendars](https://developers.pismo.io/pismo-docs/reference/list-holiday-calendars.md): List holiday calendars for an Organization. - [Get holiday calendar](https://developers.pismo.io/pismo-docs/reference/get-holiday-calendar.md): Get a holiday calendar - [List holidays](https://developers.pismo.io/pismo-docs/reference/get-holiday-new.md): List calendar holidays - [Get business day](https://developers.pismo.io/pismo-docs/reference/post-search-business-day.md): Searches for business day information for a specific date within a holiday calendar. - [Get non-business days](https://developers.pismo.io/pismo-docs/reference/get-non-business-days.md): Get non-business days (weekends and holidays) for a specific holiday calendar within a date range. Non-business days include weekends based on the holiday calendar's working days configuration and holidays associated with the group. - [Get calendar by external ID](https://developers.pismo.io/pismo-docs/reference/get-holiday-calendar-by-external-id.md): Get a holiday calendar given its external ID in path. - [Create holiday (deprecated)](https://developers.pismo.io/pismo-docs/reference/post-holiday.md): **DEPRECATED**. Call the [Add holiday](ref:post-add-holiday-to-calendar) endpoint instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Create a holiday—a day on which your company's offices are closed for normal business activity though online financial transactions and other business activity could still be occurring. For more information, refer to Platform setup - Holidays and administrative divisions. - [List holidays (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-v1-holidays.md): **DEPRECATED**. Call the Call the [List holiday calendars](ref:list-holiday-calendars) endpoint instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Return a paginated list of holidays registered for an organization. - [Get holiday (deprecated)](https://developers.pismo.io/pismo-docs/reference/validate-v1-holiday.md): **DEPRECATED**. Call the [Get business day](ref:post-search-business-day) endpoint instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Get information for an administrative division's holiday. **Note:** The response could contain outdated information until at least one minute after an update is made to an administrative division. - [Update holiday name (deprecated)](https://developers.pismo.io/pismo-docs/reference/put-v1-holiday.md): **DEPRECATED**. Call the [Update holiday](ref:update-holiday) endpoint instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Update a holiday's name. - [Delete holiday (deprecated)](https://developers.pismo.io/pismo-docs/reference/delete-v1-holiday.md): **DEPRECATED**. Call the new [Delete holiday](ref:delete-holiday) endpoint instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Delete a holiday. - [Check if business day (deprecated)](https://developers.pismo.io/pismo-docs/reference/v1-search-business-day.md): **DEPRECATED**. Call the [Get business day](ref:post-search-business-day) endpoint instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Check if a specific date is a business day for an administrative division. **Note:** The response could contain outdated information until at least one minute after an administrative division update. - [List non-business days (deprecated)](https://developers.pismo.io/pismo-docs/reference/v1-get-non-business-days.md): **DEPRECATED**. Call the [Get non-business days](ref:get-non-business-days) endpoint instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Return a list of non-business days. - [List holidays with administrative division ancestors (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-v1-holidays-with-administrative-divisions-ancestors.md): **DEPRECATED**. Call the [List holiday calendars](ref:list-holiday-calendars) endpoint instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Return a paginated list of holidays registered for an administrative division, including those inherited from a parent division. - [Create holiday (deprecated)](https://developers.pismo.io/pismo-docs/reference/post-v2-holiday.md): **DEPRECATED**. Call the [Add holiday](ref:post-add-holiday-to-calendar) endpoint instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Create a holiday—a day on which your company's offices are closed for normal business activity though online financial transactions and other business activity could still be occurring. **Note:** This endpoint is designed for transaction banking. For more information, refer to [Calendars and holidays in transaction banking](doc:calendars-and-holidays-in-transaction-banking). - [List holidays (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-v2-holidays.md): **DEPRECATED**. Call the new [List holidays](ref:get-holiday-new) endpoint instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Return a paginated list of holidays registered for an organization. **Note:** This endpoint is designed for transaction banking. For more information, refer to [Calendars and holidays in transaction banking](doc:calendars-and-holidays-in-transaction-banking). - [Update holiday (deprecated)](https://developers.pismo.io/pismo-docs/reference/put-v2-holiday.md): **DEPRECATED**. Call the new [Update holiday](ref:update-holiday) endpoint instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Update some holiday information. Only parameters that are passed are updated. **Note:** This endpoint is designed for transaction banking. For more information, refer to [Calendars and holidays in transaction banking](doc:calendars-and-holidays-in-transaction-banking). - [Create administrative division (deprecated)](https://developers.pismo.io/pismo-docs/reference/post-v1-admin-division.md): **DEPRECATED**. Call [Create holiday calendar](ref:post-create-holiday-calendar) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Create an administrative division. Administrative divisions are used to divide an organization's territory into separate areas. An organization covering Great Britian for example, might want to have separate divisions for England, Scotland, and Ireland. Each of these countries may have different holidays and need to be administered in different ways. There is a [Create administrative division](ref:post-v2-admin-division) V2 endpoint designed for greater flexibility in defining non-business days to accommodate specific business requirements. For details about the differences, refer to [Platform setup - Holidays and administrative divisions](doc:platform-setup-holidays#endpoints-for-transaction-banking). - [Get admin division info by external ID (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-v1-admin-division-external-id.md): **DEPRECATED**. Call [Get calendar by external ID](ref:get-holiday-calendar-by-external-id) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Get detailed administrative division information. - [Get admin division info (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-v1-admin-division.md): **DEPRECATED**. Call [Get holiday calendar](ref:get-holiday-calendar) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Get detailed administrative division information. - [Update administrative division (deprecated)](https://developers.pismo.io/pismo-docs/reference/put-v1-admin-division.md): **DEPRECATED**. Call [Update holiday calendar](ref:update-holiday-calendar) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Update administrative division. - [Delete administrative division (deprecated)](https://developers.pismo.io/pismo-docs/reference/delete-v1-admin-division.md): **DEPRECATED**. Call [Delete holiday calendar](ref:delete-holiday-calendar) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Delete an administrative division. - [Get admin division tree by admin division ID (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-v1-admin-division-tree-parent-id.md): **DEPRECATED**. Call [List holiday calendars](ref:list-holiday-calendars) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Get the complete tree of child administrative divisions using the parent's administrative division ID. - [Get admin division tree by external ID (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-v1-admin-division-tree-external-id.md): **DEPRECATED**. Call [List holiday calendars](ref:list-holiday-calendars) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Get the full tree of administrative divisions using an external ID - [Get admin division ancestors by admin division ID (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-v1-admin-division-ancestors-administrative-division-id.md): **DEPRECATED**. Call [List holiday calendars](ref:list-holiday-calendars) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. List ancestors for an administrative division using administrative division ID. - [Get admin division ancestors by external ID (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-v1-admin-division-ancestors-external-id.md): **DEPRECATED**. Call [List holiday calendars](ref:list-holiday-calendars) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. List ancestors for an administrative division using an external ID. - [Create administrative division (deprecated)](https://developers.pismo.io/pismo-docs/reference/post-v2-admin-division.md): **DEPRECATED**. Call [Create holiday calendar](ref:post-create-holiday-calendar) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Create an administrative division. This is a v2 endpoint that offers more granular control over financial activities on non-business days. To understand the differences between v1 and v2 endpoints, refer to [Platform setup - Holidays and administrative divisions](doc:platform-setup-holidays#endpoints-for-transaction-banking). - [Get administrative division info (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-v2-admin-division.md): **DEPRECATED**. Call [Get holiday calendar](ref:get-holiday-calendar) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Get administrative division detailed information. - [Update administrative division (deprecated)](https://developers.pismo.io/pismo-docs/reference/put-v2-admin-division.md): **DEPRECATED**. Call [Update holiday calendar](ref:update-holiday-calendar) instead. This endpoint is deprecated starting April 30, 2026, and final removal from both test (EXT) and production environments on October 30, 2026. Update an administrative division. - [Create fee model](https://developers.pismo.io/pismo-docs/reference/postmodel.md): Create fee model. A fee model is a structure that defines a collection of fees with custom calculations. You can define the method used to calculate the fee, using a fixed value or a percentage. Fee models can be applied to organizations, programs, and accounts. For more information, see the [Fee model](doc:fee-model) guide. An accumulator fee model requires you call the Create accumulator configuration endpoint first to define how transaction totals are kept. Once the fee model is created, it needs to be attached to an account, attached to a program or attached to an org. - [List fee models](https://developers.pismo.io/pismo-docs/reference/listmodel.md): Get an organization's fee models. The org ID is derived from the access token. - [Get fee model](https://developers.pismo.io/pismo-docs/reference/getmodel.md): Get a fee model given its ID in the path. - [Update fee model](https://developers.pismo.io/pismo-docs/reference/putfeemodel.md): Update a fee model - [Attach fee model to account](https://developers.pismo.io/pismo-docs/reference/attachmentbyaccount.md): Attach the fee model to an account. - [Get account fee model](https://developers.pismo.io/pismo-docs/reference/getbyaccount.md): Get the fee model attached to the account. - [Delete account fee model](https://developers.pismo.io/pismo-docs/reference/deletebyaccount.md): Delete the fee model from an account. - [Attach fee model to program](https://developers.pismo.io/pismo-docs/reference/attachmentbyprogram.md): Attach the fee model to a program. - [Get program fee model](https://developers.pismo.io/pismo-docs/reference/getbyprogram.md): Get the fee model attached to a program. - [Delete program fee model](https://developers.pismo.io/pismo-docs/reference/deleteattachbyprogram.md): Delete the fee model from the program. - [Get org fee model](https://developers.pismo.io/pismo-docs/reference/getmodelbyorg.md): Get fee model by organization, which is derived from the access token. - [Attach fee model to org](https://developers.pismo.io/pismo-docs/reference/attachmentbytenant.md): Attach a fee model to an org. The org ID is derived from the access token. - [Create simulation config](https://developers.pismo.io/pismo-docs/reference/simulationconfigs.md): Create simulation configuration for possible custom payment option. **Note:** EXTERNAL engine plans cannot be fully configured at creation time — `calculation_url` is not accepted during creation. Create the config with PISMO plans first, then use the PUT endpoint to add or update EXTERNAL engine plans with their `calculation_url`. - [Get simulation config](https://developers.pismo.io/pismo-docs/reference/getsimulationconfigs.md): Get simulation configuration given its ID in the path. - [Update simulation config](https://developers.pismo.io/pismo-docs/reference/putsimulationconfigs.md): Update a simulation configuration. **Note:** EXTERNAL engine plans (with `calculation_url`) can only be set via this endpoint — not during creation (POST). Once `calculation_url` is set, it cannot be changed. - [Attach simulation config to org](https://developers.pismo.io/pismo-docs/reference/attachorgsimulationconfig.md): Attach a simulation configuration to an organization/tenant. The org ID is derived from the access token. - [Get org simulation config](https://developers.pismo.io/pismo-docs/reference/getorgsimulationattachment.md): Get simulation configuration attached to an org. The org ID is derived from the access token. - [Attach simulation config to program](https://developers.pismo.io/pismo-docs/reference/attachprogramsimulationconfig.md): Attach a simulation configuration to a program. - [Get program simulation config](https://developers.pismo.io/pismo-docs/reference/getprogramsimulationattachment.md): Get the ID of the simulation config attached to a program. - [Detach program simulation config](https://developers.pismo.io/pismo-docs/reference/detachprogramsimulationconfig.md): Detach simulation configuration from a program. - [Attach simulation config to account](https://developers.pismo.io/pismo-docs/reference/attachaccountsimulationconfig.md): Attach simulation configuration to an account. - [Get account simulation config](https://developers.pismo.io/pismo-docs/reference/getaccountsimulationattachment.md): Get the ID of the simulation configuration attached to an account. - [Detach account simulation config](https://developers.pismo.io/pismo-docs/reference/detachaccountsimulationconfig.md): Detach simulation configuration from an account. - [Get Simulation configuration details](https://developers.pismo.io/pismo-docs/reference/getsimulationconfigsv1.md): Retrieve simulation configs based on the filters - [Get simulation attachments](https://developers.pismo.io/pismo-docs/reference/getsimulationattachments.md): Retrieve simulation attachment details based on the filters - [Create exchange rate](https://developers.pismo.io/pismo-docs/reference/createexchangerates.md): Define the exchange rate for international transactions. You **must** use this endpoint or [Pismo Control Center](doc:exchange-rates) to define the exchange rate for today or tomorrow. Exchange rates are defined at the organization level but, optionally, you can define rates for a specific program and the platform uses this rate and not the org rate for all program-related transactions. **Note:** For more information, refer to [Exchange rates for international transactions](https://developers.pismo.io/pismo-docs/docs/exchange-rate#exchange-rates-for-international-transactions). - [Get exchange rates](https://developers.pismo.io/pismo-docs/reference/getexchange.md): Returns exchange rates with paging and filter options - [Create reversal processing code](https://developers.pismo.io/pismo-docs/reference/reversalprocessingcode.md): Create a reversal processing code for an existing processing code. This endpoint creates a `REVERSAL` type processing code and a [Orgs operation created](https://developers.pismo.io/events/docs/orgs-operation-create-1) event. - [Create processing code](https://developers.pismo.io/pismo-docs/reference/createprocessingcode.md): Create a processing code for an organization. Processing codes identify financial operations on the Pismo platform. For example, `00` is a purchase, `01` is a withdrawal, and so on. Processing codes need to be mapped to [transaction types](doc:transactiontypes) to create a transaction flow. This endpoint creates an `AUTHORIZATION` type processing code and generates a [Orgs operation created](https://developers.pismo.io/events/docs/orgs-operation-create-1) event. **Notes:** * The prefix `PSM` is reserved at Pismo platform, customers are not allowed to use this prefix when creating custom processing codes . Not all standard processing codes have the `PSM`prefix. There are codes created before this standard and are kept for backward compatibility. New ones, however, will always have this prefix. * On the Pismo platform, 2-digit processing codes are reserved and used only for network processing. Because of this, customers are not allowed to have 2-digit custom processing codes. * When a new standard processing code is created, it is replicated and configured to all platform organizations, no action is required on your part. * This endpoint generates a [Orgs operation created](https://developers.pismo.io/events/docs/orgs-operation-create-1) event. For more information, refer to Processing codes. - [List processing codes](https://developers.pismo.io/pismo-docs/reference/processingcodelist.md): Get an organization's processing codes with filtering options. - [Get processing code](https://developers.pismo.io/pismo-docs/reference/processingcodefetchbyorgsoperationid.md): Get details about a specific processing code. - [Update processing code](https://developers.pismo.io/pismo-docs/reference/processingcodeupdate.md): Update a processing code. Only fields passed are updated. This endpoint generates a [Orgs operation updated](https://developers.pismo.io/events/docs/orgs-operation-update-1) event. - [List account limits](https://developers.pismo.io/pismo-docs/reference/get-v1-account-limit.md): List available limits on the account. Refer to the [Account limits](doc:working-with-limits-objects) guide for more information. - [Update account limits (outdated)](https://developers.pismo.io/pismo-docs/reference/patch-v1-account-limit.md): Update account limits. This endpoint does not validate the account limit against the program’s global limit. To validate the account limit against the program’s global limit, use the [Update account limits](ref:patch-v1-account-limits) endpoint. This endpoint generates the [Account limit changed](https://developers.pismo.io/events/docs/ledger-limit-changed-1) event. Refer to the [Account limits](doc:working-with-limits-objects) guide for more information. - [Create account application](https://developers.pismo.io/pismo-docs/reference/post-acquisitions-v3-s2s-applications.md): Create a new account application. If `submit` is set to `false`: - The application is not sent for processing and can be further modified with incremental changes via [Update account application](ref:patch-acquisitions-v2-s2s-applications). - This endpoint generates an [Account application prospect created](https://developers.pismo.io/events/docs/onboarding-prospect-1) event. If `submit` flag is set to `true`: - No further updates can be made and the account application is sent out for processing, which creates an account and its associated structures. - This endpoint generates an [Account application created](https://developers.pismo.io/events/docs/onboarding-succeeded-1) event. **Warning**—Some of the account's elements are created asynchronously and you should refrain from accessing the account via other endpoints until the events this endpoint generates are received. **Notes:** * Either the `personal` object or `company` object is **REQUIRED**. Pass one or the other but not both. * This endpoint creates a default `entity` object for the account owner based on document ID. Refer to the [Core objects](doc:setup-overview) and the [Accounts](doc:accounts-overview) guides for more information. - [Get account application](https://developers.pismo.io/pismo-docs/reference/getapplicationbyapplicationid.md): Get account application given application ID in the path. - [Update account application](https://developers.pismo.io/pismo-docs/reference/patch-acquisitions-v2-s2s-applications.md): Update a previously-created account application, only if the account application's `submit` field is `false`. If `submit` is set to `false`: - The application is not sent for processing and can be further modified with incremental changes via this endpoint. If `submit` flag is set to `true`: - No further updates can be made and the account application is sent out for processing, which creates an account and its associated structures. - This endpoint generates an [Account application created](https://developers.pismo.io/events/docs/onboarding-succeeded-1) event. **Warning**—Some of the account's elements are created asynchronously and you should refrain from accessing the account via other endpoints until the events this endpoint generates are received. **Notes:** * By default, `prospect_cancel` is `false`. If you set `prospect_cancel` to `true`, the account application is canceled and no further updates can be made. * You **cannot** update a previously-entered address. All addresses entered are considered new. The main address is the last one passed with `mailing_address` = `true`. * You **cannot** update a previously-entered `partner` object. All partner information entered is considered new. * For all other objects and fields, anything not passed is not updated. - [List acquisition channels](https://developers.pismo.io/pismo-docs/reference/get-acquisitions-v2-programs-programid-channels.md): List acquisition channels registered for a specific program. The acquisition channel is the unique ID of the original source of your customer (such as a referring web page or mobile app). Acquisition channels are configured at the program level. - [List accounts by phone number](https://developers.pismo.io/pismo-docs/reference/post-accounts-v5-accounts-search.md): List accounts by phone number. - [List accounts by document number](https://developers.pismo.io/pismo-docs/reference/post-accounts-v3-accounts-search.md): Search for accounts by `document_number`. You can also optionally specify `program_ID` or `account_status`. - [Get account](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-accounts.md): Get a summary of registration information related to a specific account, as well as some financial data such as its current balance. **Notes** * Some of the fields returned vary depending on whether the account was created with a `person` or `company` object as the account owner. The `entity_type` (`INDIVIDUAL`, `COMPANY`) identifies this. * The fields `name`, `email_address`, `customer_id` and `document_number` are either person or company-related. * The field `social_name` is only specific to a person. - [Update account](https://developers.pismo.io/pismo-docs/reference/patch-accounts-v1-accounts.md): Update some account information. Fields not passed are not updated. This endpoint generates an [Account information changed](https://developers.pismo.io/events/docs/account-account-change-2) event. - [Create account application (deprecated)](https://developers.pismo.io/pismo-docs/reference/post-acquisitions-v2-s2s-applications.md): This endpoint is **DEPRECATED**. Use the new [Create account application](ref:post-acquisitions-v3-s2s-applications) instead. Create a new account application. If the `submit` property is set to `false`: - The application is not sent for processing and can be further PATCH-ed with incremental changes. - This endpoint generates an [Account application prospect created](https://developers.pismo.io/events/docs/onboarding-prospect-1) event. If the `submit` flag is set to `true`: - No further updates can be made and the account application is sent out for processing, which creates an account and its associated structures. - This endpoint generates an [Account application created](https://developers.pismo.io/events/docs/onboarding-succeeded-1) event. - [Get account hierarchy ascendants](https://developers.pismo.io/pismo-docs/reference/get-accounts-v4-accounts-accountid-hierarchy-ascendants.md): Get account hierarchy information including all parent/ancestor accounts. This endpoint returns the account details along with an array of all parent accounts in the hierarchy, with each parent containing information about its level, centralizer status, and relationship to other accounts in the hierarchy. - [Update parameter](https://developers.pismo.io/pismo-docs/reference/account-parameters-update.md): Update account parameter value. For more information on account parameters, refer to the [account parameters guide](doc:account-parameters-reference-table). Account parameters are a subset of [program parameters](doc:program-parameters-reference-table). - [Get parameter](https://developers.pismo.io/pismo-docs/reference/account-parameters-get.md): Get account parameter registered for the organization. For more information on account parameters, refer to the [account parameters guide](doc:account-parameters-reference-table). Account parameters are a subset of [program parameters](doc:program-parameters-reference-table). - [List parameters](https://developers.pismo.io/pismo-docs/reference/account-parameters-find.md): List account parameters. For more information on account parameters, refer to the [account parameters guide](doc:account-parameters-reference-table). Account parameters are a subset of [program parameters](doc:program-parameters-reference-table). - [Create customer](https://developers.pismo.io/pismo-docs/reference/customerv2post.md): Create a new account customer. There are 3 customer types you can create with this endpoint: a `company` customer, a `person` customer, or a person customer with less informational fields (`customer` object). Each account contains at least one customer. You can add multiple customers to an account but only one can be the account owner. Other customers can have their own individual cards, but the balances on those cards must be shared with the account owner. This endpoint generates a [Customer created](https://developers.pismo.io/events/docs/account-customer-creation-1) event. If the `customer.is_owner` property is set to `true`: * The account owner is changed to this new customer, and all existing customers remain active in the account. * This endpoint generates an [Account owner changed](https://developers.pismo.io/events/docs/account-account-owner-change-1) event. If the `customer.is_active` = `true`, and the `Maximum number of card holders` program parameter is set, this customer is counted in the limit of maximum number of card holders for an account. Each customer has an associated entity object. If one isn't passed in the request, a default one is created using their document number. Refer to the [Core objects](doc:setup-overview) guide for more information. - [List customers](https://developers.pismo.io/pismo-docs/reference/customersv2get.md): List account customers with filtering options. For each customer, the shorter `customer` object is returned. This object does not contain the additional informational fields provided for person or company customers. - [Get customer](https://developers.pismo.io/pismo-docs/reference/customerv2get.md): Use the customer ID to get customer and associated entity details. To get a list of customer IDs, call [List account customers](ref:customersv2get). Depending on customer, either the `person`, `company`, or `customer` (less informational fields than `person`) object is returned. - [Overwrite customer](https://developers.pismo.io/pismo-docs/reference/customerv2put.md): Overwrite some customer information. This endpoint allows you to mark the customer on the account as active or inactive using the `is_active` field. This field is informative only. There are no restrictions that prevent inactive customers from performing any actions. If `customer.is_active` = `true`, and the `Maximum number of card holders` program parameter is set, this customer is counted in the account's maximum number of card holders limit. If the `customerId` parameter is not set, the server returns "Cannot get property `customerId` on null object". **Note:** If `social_name` and `nickname` are not passed, their values are overwritten as null. This endpoint generates a [Customer changed](https://developers.pismo.io/events/docs/account-customer-change-2) event. - [Update person or company customer](https://developers.pismo.io/pismo-docs/reference/customerv1patch.md): Update the account's person or company customer information. Fields not passed are not updated. This endpoint generates an [Account entity updated](https://developers.pismo.io/events/docs/audit-entity-change-1) event. If the `customer.is_owner` property is set to `true`: - The account owner is changed to this new customer, and all existing customers remain active in the account. - This endpoint generates an [Account owner changed](https://developers.pismo.io/events/docs/account-owner-change-1) event. If `customer.is_active = true`, and the **Maximum number of card holders** program parameter is set, this customer is counted in the limit of maximum number of card holders for an account. - [Create address](https://developers.pismo.io/pismo-docs/reference/post-accounts-v1-accounts-accountid-addresses.md): Create a new address for the specified account. This endpoint generates an [Address created](https://developers.pismo.io/events/docs/audit-address-creation-1) event. - [List addresses](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-accounts-accountid-addresses.md): List addresses defined for the specified account. - [Get address](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-accounts-accountid-addresses-addressid.md): Get address information using an account ID and address ID. To get a list of address IDs, call [List addresses](ref:get-accounts-v1-accounts-accountid-addresses). - [Update address](https://developers.pismo.io/pismo-docs/reference/patch-accounts-v1-accounts-accountid-addresses-addressid.md): Update an address. This endpoint generates an [Address updated](https://developers.pismo.io/events/docs/audit-address-change-1) event. - [Create phone](https://developers.pismo.io/pismo-docs/reference/post-accounts-v1-accounts-accountid-phones.md): Create a new phone number for the specified account. This event generates a [Phone created](https://developers.pismo.io/events/docs/audit-phone-creation-1) event. - [List phones](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-accounts-accountid-phones.md): List an account's phone numbers with filtering options. - [Get phone](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-accounts-accountid-phones-phoneid.md): Get a phone number. To get a list of phone IDs, call [List phones](ref:get-accounts-v1-accounts-accountid-phones). - [Update phone](https://developers.pismo.io/pismo-docs/reference/patch-accounts-v1-accounts-accountid-phones-phoneid.md): Update phone number. This event generates a [Phone updated](https://developers.pismo.io/events/docs/audit-phone-change-1) event. - [Create status](https://developers.pismo.io/pismo-docs/reference/v4-post-account-status.md): Create an account status on the platform. When a new account status is created, its initial `state` (see response) is `ACTIVE`. This endpoint generates an [Account status created](https://developers.pismo.io/events/docs/account-status-creation-1) event. Refer to the [Account status](doc:accounts-overview#account-status) guide section for more information. - [List statuses](https://developers.pismo.io/pismo-docs/reference/v4-get-account-status.md): List account statuses registered for the organization. The org ID is parsed from the access token. - [Update status](https://developers.pismo.io/pismo-docs/reference/patch-accounts-v2-accounts-accountid-status.md): Update account status. This endpoint generates an [Account status changed](https://developers.pismo.io/events/docs/account-status-change-2) event. Refer to the [Account status](doc:accounts-overview#account-status) guide for more information. - [Roll back status](https://developers.pismo.io/pismo-docs/reference/patch-v2-accounts-accountid-status-rollback.md): Reset account status to `NORMAL`. This endpoint generates an [Account status changed](https://developers.pismo.io/events/docs/account-status-change-2) event. - [Create status reason](https://developers.pismo.io/pismo-docs/reference/v4-post-account-reason.md): Create an account status reason on the platform. This endpoint generates a [Reason created](https://developers.pismo.io/events/docs/account-reason-creation-1) event. For more information, refer to the [Account status](doc:accounts-overview#account-status) guide section. - [List status reasons](https://developers.pismo.io/pismo-docs/reference/v4-get-account-reason.md): List account status reasons for the Organization. The Org ID is parsed from the access token. - [List statuses V1 (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-account-status.md): List account statuses registered for the organization. - [List status reasons V1 (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-accounts-status-reasons.md): List available reasons for the specific account status, with several filtering options. - [Transfer account to different program](https://developers.pismo.io/pismo-docs/reference/postmigrationprogram.md): Change the program ID for an account. This also changes the program ID for customers and statements associated with the account. Note that the account keeps the original program's flex controls and ignores the new program's flex controls. Transfer is permitted **only** if both programs (origin and target) have the same: * [Program type](doc:program-types)—For example, you can migrate from credit to credit and from prepaid to prepaid, but not credit to prepaid. * Currency—For example, USD to USD only or BRL to BRL only. * Brand (if applicable)—For example, Mastercard to Mastercard. * Due date (credit programs only)—Account due date must be available in the target program. **Notes:** * Transferring an account does not affect account limits * When an account is transferred successfully, you need to issue a new card that corresponds to the new program for your customers. This endpoint generates an [Account migrated to different program](https://developers.pismo.io/events/docs/account-program-migration-1) event. - [List accounting event types](https://developers.pismo.io/pismo-docs/reference/searchevents.md): List accounting event types for your organization. Refer to the [Search for accounting event types](doc:search-for-accounting-event-types) for more information. - [Get accounting event type](https://developers.pismo.io/pismo-docs/reference/geteventtypebyid.md): Get a specific accounting event type by its ID. Refer to the [Search for accounting event types](doc:search-for-accounting-event-types) for more information. - [Create accounting entry types](https://developers.pismo.io/pismo-docs/reference/createentrytypev2.md): Create accounting entry type for your organization. - [List accounting entry types](https://developers.pismo.io/pismo-docs/reference/searchentrytypesv2.md): List accounting entry types with their latest history from your organization. - [Get accounting entry type](https://developers.pismo.io/pismo-docs/reference/getentrytypebyidv2.md): Get a specific accounting entry type by its ID with its historic information. - [Update accounting entry type](https://developers.pismo.io/pismo-docs/reference/updateentrytypev2.md): Update a specific accounting entry type by its ID. - [Delete accounting entry type](https://developers.pismo.io/pismo-docs/reference/deleteentrytypev2.md): Delete a specific accounting entry type by its ID. - [List accounting entry types (outdated)](https://developers.pismo.io/pismo-docs/reference/searchentrytypes.md): List accounting entry types from your organization. This endpoint is outdated and new endpoint is available: [List accounting entry types](ref:searchentrytypesv2). Refer to [Search for accounting entry types](doc:create-accounting-entries#search-for-accounting-entry-types) for more information. - [Get accounting entry type (outdated)](https://developers.pismo.io/pismo-docs/reference/getentrytypebyid.md): Get a specific accounting entry type by its ID. This endpoint is outdated and new endpoint is available: [Get accounting entry type](ref:getentrytypebyidv2). Refer to [Search for accounting entry types](doc:create-accounting-entries#search-for-accounting-entry-types) for more information. - [Create accounting account](https://developers.pismo.io/pismo-docs/reference/createaccountingaccount.md): Create an accounting account. Refer to the [How to create accounting account](doc:create-an-accounting-account) guide for more information. - [List accounting accounts](https://developers.pismo.io/pismo-docs/reference/searchaccountingaccounts.md): List accounting accounts for your organization. - [Get accounting account](https://developers.pismo.io/pismo-docs/reference/getaccountingaccountbyid.md): Get a specific accounting account by its ID. - [Update accounting account](https://developers.pismo.io/pismo-docs/reference/updateaccountingaccount.md): Update description of an accounting account. - [Delete accounting account](https://developers.pismo.io/pismo-docs/reference/deleteaccountingaccount.md): Delete an accounting account. - [Create accounting script V2](https://developers.pismo.io/pismo-docs/reference/createaccountingscriptv2.md): Create an accounting script. Refer to the [How to create accounting script](doc:create-an-accounting-script) guide for more information. - [List accounting scripts V2](https://developers.pismo.io/pismo-docs/reference/listaccountingscriptsv2.md): List existing accounting scripts for your organization. - [Get accounting script V2](https://developers.pismo.io/pismo-docs/reference/getaccountingscriptbyidv2.md): Get a specific accounting script by its ID. - [Create accounting script V1](https://developers.pismo.io/pismo-docs/reference/createaccountingscript.md): Create an accounting script. Refer to the [How to create accounting script](doc:create-an-accounting-script) guide for more information. - [List accounting scripts V1](https://developers.pismo.io/pismo-docs/reference/searchaccountingscript.md): List existing accounting scripts for your organization. - [Get accounting script V1](https://developers.pismo.io/pismo-docs/reference/getaccountingscriptbyid.md): Get a specific accounting script by its ID. - [Update accounting scripts V1](https://developers.pismo.io/pismo-docs/reference/batchupdateaccountingscript.md): Update accounting scripts. - [Update accounting script V1](https://developers.pismo.io/pismo-docs/reference/updateaccountingscript.md): Update accounting script. - [Deactivate accounting script V1](https://developers.pismo.io/pismo-docs/reference/deactivateaccountingscript.md): Deactivate an accounting script by its ID. - [Create accounting entry](https://developers.pismo.io/pismo-docs/reference/createaccountingentry.md): Create an accounting entry. This endpoint generates an [Accounting entry created](https://developers.pismo.io/events/docs/accounting-entry-creation-1) event. Refer to the [How to create accounting entries](doc:create-accounting-entries) guide for more information. - [Get account buckets](https://developers.pismo.io/pismo-docs/reference/getbucketsbyaccount.md): Get one or all buckets for a specific tenant. Buckets are accumulators that are related to an accounting script. Buckets can have their values changed with each related accounting entry. - [Create accumulator configuration](https://developers.pismo.io/pismo-docs/reference/post-v1-accumulator-config.md): Creates a new accumulator configuration, which keeps running totals for specified transaction types. Fees are applied to these totals based on an associated fee model. After you create an accumulator configuration, you need to: 1. Create a fee model referencing the accumulator configuration. 2. Attach the fee model to a program or account. - [List accumulator configurations](https://developers.pismo.io/pismo-docs/reference/get-config-accumulators.md): Get config accumulators - [Get accumulator configuration](https://developers.pismo.io/pismo-docs/reference/get-v1-accumulator-config.md): Gets the accumulator configuration You can get accumulator configuration IDs with the [List accumulator configuration](ref:get-config-accumulators) endpoint. - [Update accumulator configuration](https://developers.pismo.io/pismo-docs/reference/patch-v1-accumulator-config.md): Update accumulator configuration - [List account accumulators](https://developers.pismo.io/pismo-docs/reference/search-account-accumulators.md): List account accumulators. *NOTE*: This endpoint requires an account-specific access token. - [Get related accounts](https://developers.pismo.io/pismo-docs/reference/get-v1-accounts-limits-related-accounts.md): Get balances and limits of all related accounts given the main account ID. Refer to the [Related accounts](doc:accounts-overview#related-accounts) section in the Accounts guide for more information. - [Get daily account balance limits](https://developers.pismo.io/pismo-docs/reference/get-v1-account-balance.md): Get daily account balance limits for a date range. By default, if only the account ID is specified, the range is 10 days: from 10 days before yesterday's date to yesterday. You can query the account balance limits as far back as 515 days before the current date and for a maximum range of 90 days. You can't query for today's date. Refer to the [Get daily account balance limits](doc:accounts-overview#get-daily-account-balance-limits) section in the Accounts guide for more information. - [Configure program limit](https://developers.pismo.io/pismo-docs/reference/post-v1-global-configs.md): Configure the maximum granted limit allowed for a program within an organization. Refer to the [Program limits](doc:program-limits) guide for more information. - [Get program limits](https://developers.pismo.io/pismo-docs/reference/get-v1-global-configs.md): Get a configured global limit granted for a program along with its current accumulated limit value. Refer to the [Program limits](doc:program-limits) guide for more information. - [Update program limit](https://developers.pismo.io/pismo-docs/reference/patch-v1-global-configs-program-programid.md): Update the existing program limit. Refer to the [Program limits](doc:program-limits) guide for more information. - [Update account limits](https://developers.pismo.io/pismo-docs/reference/patch-v1-account-limits.md): Update account limits for a specific account. This endpoint triggers validation against the global program limit configured in the [Configure program limit](ref:post-v1-global-configs) endpoint. This endpoint generates the [Account limit changed](https://developers.pismo.io/events/docs/ledger-limit-changed-1) event. Refer to the [Account limits](doc:working-with-limits-objects) guide for more information. - [Create balance configuration](https://developers.pismo.io/pismo-docs/reference/post-v1-balances-config.md): Create a balance configuration that determines how authorizations on the Pismo platform impact account balances and limits. To create a balance configuration, define its applicability level, filters, conditions, and results. For more information, refer to the [Balance configurations overview](doc:balances-configurations-overview) guide. - [List balance configurations](https://developers.pismo.io/pismo-docs/reference/get-v1-balances-config.md): List balance configurations available for the organization. You can also filter the results by program or account. - [Get balance configuration](https://developers.pismo.io/pismo-docs/reference/get-v1-balances-config-by-id.md): Get a balance configuration by its ID. - [Replace balance configuration](https://developers.pismo.io/pismo-docs/reference/put-v1-balances-config.md): Replace an exiting balance configuration. - [Create filter template](https://developers.pismo.io/pismo-docs/reference/post-v1-filter-templates.md): Create a reusable filter template that can be referenced in balance configurations. Filter templates allow you to define common filter criteria once and reuse them across multiple configurations. For more information, refer to the [Balance configurations filter templates](doc:filter-templates) guide. - [List filter templates](https://developers.pismo.io/pismo-docs/reference/get-v1-filter-templates.md): List all filter templates available for the organization with pagination support. - [Get filter template](https://developers.pismo.io/pismo-docs/reference/get-v1-filter-template-by-id.md): Get a specific filter template by its ID. - [Update filter template](https://developers.pismo.io/pismo-docs/reference/put-v1-filter-template.md): Update filter template. Each update will version the filter template, allowing you to track changes over time. - [Create limit config by Org](https://developers.pismo.io/pismo-docs/reference/post-config-by-tenant-1.md): Create a limit configuration for authorizations on the organization (Org) level. This level can be used as a default configuration for all programs and accounts in this Org. There can be only one configuration by Org. New creation attempts for the same Org get a conflict response. This configuration currently supports only the over-limit feature. See the [Over-limit fee](doc:over-limit-fee) guide for more information. - [Get limit config by Org](https://developers.pismo.io/pismo-docs/reference/get-config-by-tenant-1.md): Get the limit configuration for authorizations on the Org level. - [Update limit config by Org](https://developers.pismo.io/pismo-docs/reference/put-config-by-tenant-1.md): Update the limit configuration for authorizations on the Org level. This endpoint updates the entire configuration, so you must send all fields to avoid data loss. - [Create limit config by program](https://developers.pismo.io/pismo-docs/reference/post-config-by-program-1.md): Create a limit configuration for authorizations on the program level. This level is a more granular level than Org and can be used as a default configuration for all accounts in this program. There can be only one configuration by program. New creation attempts for the same program get a conflict response. This configuration currently supports only the over-limit feature. See the [Over-limit fee](doc:over-limit-fee) guide for more information. - [Get limit config by program](https://developers.pismo.io/pismo-docs/reference/get-config-by-program-1.md): Get the limit configuration for authorizations on the program level. - [Update limit config by program](https://developers.pismo.io/pismo-docs/reference/put-config-by-program-1.md): Update the limit configuration for authorizations on the program level. This endpoint updates the entire configuration, so you must send all fields to avoid data loss. - [Create limit config by account](https://developers.pismo.io/pismo-docs/reference/post-config-by-account-1.md): Create a limit configuration for authorizations on the account level. This is the most granular level allowed and can be used to customize a specific account. There can be only one configuration by account. New creation attempts for the same account get a conflict response. This configuration currently supports only the over-limit feature. See the [Over-limit fee](doc:over-limit-fee) guide for more information. - [Get limit config by account](https://developers.pismo.io/pismo-docs/reference/get-config-by-account-1.md): Get the limit configuration for authorizations on the account level. - [Update limit config by account](https://developers.pismo.io/pismo-docs/reference/put-config-by-account-1.md): Update the limit configuration for authorizations on the account level. This endpoint updates the entire configuration, so you must send all fields to avoid data loss. - [Create limit acceptance config by Org](https://developers.pismo.io/pismo-docs/reference/post-acceptance-by-tenant-1.md): Create a limit acceptance configuration for authorizations on the organization (Org) level. This configuration applies to authorizations generated by operations defined in the provided processing code. This level can be used as a default configuration for all programs and accounts in this Org. There can be only one configuration by Org. New creation attempts for the same Org get a conflict response. At least one of the following objects is **required** in this request: - `network_authorization` - `platform_authorization` - `authorization` This configuration currently supports only the over-limit feature. See the [Over-limit fee](doc:over-limit-fee) guide for more information. - [Get limit acceptance config by Org](https://developers.pismo.io/pismo-docs/reference/get-acceptance-by-tenant-1.md): Get the limit acceptance configuration for authorizations on the Org level. This configuration applies to authorizations generated by operations defined in the provided processing code. - [Update limit acceptance config by Org](https://developers.pismo.io/pismo-docs/reference/put-acceptance-by-tenant-1.md): Update the limit acceptance configuration for authorizations on the Org level. This configuration applies to authorizations generated by operations defined in the provided processing code. At least one of the following objects is **required** in this request: - `network_authorization` - `platform_authorization` - `authorization` This endpoint updates the entire configuration, so you must send all fields to avoid data loss. - [Create limit acceptance config by program](https://developers.pismo.io/pismo-docs/reference/post-acceptance-by-program-1.md): Create a limit acceptance configuration for authorizations on the program level. This configuration applies to authorizations generated by operations defined in the provided processing code. This level is a more granular level than Org and can be used as a default configuration for all accounts in this program. There can be only one configuration by program. New creation attempts for the same program get a conflict response. At least one of the following objects is **required** in this request: - `network_authorization` - `platform_authorization` - `authorization` This configuration currently supports only the over-limit feature. See the [Over-limit fee](doc:over-limit-fee) guide for more information. - [Get limit acceptance config by program](https://developers.pismo.io/pismo-docs/reference/get-acceptance-by-program-1.md): Get the acceptance configuration on the program level. This configuration applies to authorizations generated by operations defined in the provided processing code. - [Update limit acceptance config by program](https://developers.pismo.io/pismo-docs/reference/put-acceptance-by-program-1.md): Update the limit acceptance configuration for authorizations on the program level. This configuration applies to authorizations generated by operations defined in the provided processing code. At least one of the following objects is **required** in this request: - `network_authorization` - `platform_authorization` - `authorization` This endpoint updates the entire configuration, so you must send all fields to avoid data loss. - [Create limit acceptance config by account](https://developers.pismo.io/pismo-docs/reference/post-acceptance-by-account-1.md): Create a limit acceptance configuration for authorizations on the account level. This configuration applies to authorizations generated by operations defined in the provided processing code. This is the most granular level allowed and can be used to customize a specific account. There can be only one configuration by account. New creation attempts for the same account get a conflict response. At least one of the following objects is **required** in this request: - `network_authorization` - `platform_authorization` - `authorization` This configuration currently supports only the over-limit feature. See the [Over-limit fee](doc:over-limit-fee) guide for more information. - [Get limit acceptance config by account](https://developers.pismo.io/pismo-docs/reference/get-acceptance-by-account-1.md): Get the limit acceptance configuration for authorizations on the account level. This configuration applies to authorizations generated by operations defined in the provided processing code. - [Update limit acceptance config by account](https://developers.pismo.io/pismo-docs/reference/put-acceptance-by-account-1.md): Update the limit acceptance configuration for authorizations on the account level. This configuration applies to authorizations generated by operations defined in the provided processing code. At least one of the following objects is **required** in this request: - `network_authorization` - `platform_authorization` - `authorization` This endpoint updates the entire configuration, so you must send all fields to avoid data loss. - [Create account flex control](https://developers.pismo.io/pismo-docs/reference/post-v1-accounts-flex-controls.md): Creates flex control for account. You use flex controls to restrict financial operations. For example, you can set spending and usage limits. For more information, refer to [Flexible transaction controls](doc:flex-controls). To create a cumulative condition, the `type` can be: - `spending_limit` to restrict the maximum total amount that can be transacted during an specific period. - `usage_limit` to evaluate the quantity of transactions. The cumulative control type must also specify the `max_limit`. The `limit_duration` and `reset_period` parameters are optional, but they are linked with the behavior of `max_limit`. To create a restriction condition, set `type` as `restriction`. To restrict an operation, the restriction control must specify: - at least one condition in the `conditions` array. - the required values for `attribute`, `operator`, and `value` in the condition. Once you create the control, you can't change its type. This endpoint generates an [Account flex control created](https://developers.pismo.io/events/docs/audit-account-spending-limit-created-1) event. NOTE: This endpoint requires an account-specific access token. - [List account flex controls](https://developers.pismo.io/pismo-docs/reference/get-v1-accounts-flex-controls.md): List the flex controls, given the `accountId`. NOTE: This endpoint requires an account-specific access token. - [Get account customers' flex controls](https://developers.pismo.io/pismo-docs/reference/get-v1-accounts-customers-flex-controls.md): Get flex controls for all customers related to an account. NOTE: This endpoint requires an account-specific access token. - [Get account flex control](https://developers.pismo.io/pismo-docs/reference/get-v1-accounts-flex-control.md): Get a flex control, given the `accountId` and `flexControlId`. NOTE: This endpoint requires an account-specific access token. - [Update account flex control](https://developers.pismo.io/pismo-docs/reference/patch-v1-accounts-flex-control.md): Update an account flex control. If you want to disable any flex control at the program level, you need to submit a request to the Pismo support team to change the active status parameter to false. This endpoint generates an [Account flex control updated](https://developers.pismo.io/events/docs/audit-account-spending-limit-updated-1) event. NOTE: This endpoint requires an account-specific access token. - [Create customer flex control](https://developers.pismo.io/pismo-docs/reference/post-v1-customers-flex-controls.md): Creates flex control for customer. You use flex controls to restrict financial operations. For example, you can set spending and usage limits. See [Flexible transaction controls](https://developers.pismo.io/pismo-docs/docs/flex-controls) for more information. To create a cumulative condition, the `type` can be: - `spending_limit` to restrict the maximum total amount that can be transacted during an specific period. - `usage_limit` to evaluate the quantity of transactions. The cumulative control type must also specify the `max_limit`. The `limit_duration` and `reset_period` parameters are optional, but they are linked with the behavior of `max_limit`. To create a restriction condition, set `type` as `restriction`. To restrict an operation, the restriction control must specify: - at least one condition in the `conditions` array. - the required values for `attribute`, `operator`, and `value` in the condition. Once you create the control, you can't change its type. This endpoint generates a [Customer flex control created](https://developers.pismo.io/events/docs/audit-customer-spending-limit-created-1) event. NOTE: This endpoint requires an account-specific access token. - [List customer flex controls](https://developers.pismo.io/pismo-docs/reference/get-v1-customers-flex-controls.md): List flex controls for a customer. NOTE: This endpoint requires an account-specific access token. - [Get customer flex control](https://developers.pismo.io/pismo-docs/reference/get-v1-customers-flex-control.md): Get a flex control, given the `customerId` and `flexControlId`. NOTE: This endpoint requires an account-specific access token. - [Update customer flex control](https://developers.pismo.io/pismo-docs/reference/patch-v1-customers-flex-control.md): Update a customer flex control. If you want to disable any flex control at the program level, you need to submit a request to the Pismo support team to change the active status parameter to false. This endpoint generates a [Customer flex control updated](https://developers.pismo.io/events/docs/audit-customer-spending-limit-updated-1) event. NOTE: This endpoint requires an account-specific access token. - [List program flex controls](https://developers.pismo.io/pismo-docs/reference/get-v1-flex-controls.md): List all flex controls grouped by program, with pagination support. Results are ordered by program ID in ascending order. Use the optional `programId` query parameter to filter results to a single program. If `programId` is provided and no templates are found for that program, a `404` is returned. If no `programId` is specified and no templates exist at all, an empty paginated response is returned with status `200`. - [Create attribute group](https://developers.pismo.io/pismo-docs/reference/post-v1-attribute-group-flex-controls.md): Create an attribute group, which is a set of values that can be shared across multiple flex controls within the organization. Once you create an attribute group, you reference it in flex controls in the `conditions` field in the [Create account flex control](ref:post-v1-accounts-flex-controls) or [Create customer flex control](ref:post-v1-customers-flex-controls) endpoint. For more information, refer to the [Attribute groups](doc:attribute-groups) guide. - [List attribute groups](https://developers.pismo.io/pismo-docs/reference/get-v1-attribute-groups.md): List all available attribute groups in the organization. You can optionally provide the `limit` query parameter to specify the maximum number of groups to return per page. - [Get attribute group](https://developers.pismo.io/pismo-docs/reference/get-v1-attribute-groups-groupid.md): Get a specific attribute group by its ID. - [Update attribute group](https://developers.pismo.io/pismo-docs/reference/update-v1-attribute-groups.md): Update the `values` field in an attribute group. All other attribute group fields are immutable. - [Request authorization](https://developers.pismo.io/pismo-docs/reference/post-authorization.md): Use this endpoint to request a new authorization, cancel an existing authorization, or confirm an existing authorization. With this endpoint, you can set `validation_rules` to control the rules in this flow, such as disabling a rule, changing the response code and denial code, and forcing a rule. Refer to the [Payment methods](doc:payment-methods) guide for additional information. This endpoint generates [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) and [Payment methods authorization created](https://developers.pismo.io/events/docs/payment-methods-authorization-1) events. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Create cash-in or cash-out](https://developers.pismo.io/pismo-docs/reference/post-payments.md): Create a cash-in or cash-out payment operation. The type of operation depends on the processing code (credit for cash-in and debit for cash-out). - For cash-in operations, the processing code must be of credit type. When [creating a processing code](ref:createprocessingcode), ensure that the `balance_impact` is `1` (credit). - For cash-out operations, the processing code must be of debit type. When [creating a processing code](ref:createprocessingcode), ensure that the `balance_impact` is `-1` (debit). With this endpoint, you have the following additional options. - Specify the `authentication` method and details. - Set `pre_authorization` to `true` for operations that require additional confirmation and then call the [Confirm pre-authorized cash-in or cash-out](ref:post-payment-confirm) endpoint. - Set `validation_rules` to control the rules in this flow, such as disabling a rule, changing the response code and denial code, and forcing a rule. Refer to the [Payment methods](doc:payment-methods) and [Payment configurations](doc:payments-configurations) guides for additional information. This endpoint generates a [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Cancel cash-in or cash-out](https://developers.pismo.io/pismo-docs/reference/post-payments-cancel.md): Cancel an existing payment operation. If you don't provide the `amount`, the platform cancels the total original amount. You can also provide the `amount` to cancel a total or partial amount. Refer to the [Payment methods](doc:payment-methods) guide for additional information. This endpoint generates a [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Confirm pre-authorized cash-in or cash-out](https://developers.pismo.io/pismo-docs/reference/post-payment-confirm.md): Confirm a pre-authorized payment operation. Use this endpoint only if the created payment operation had the `pre_authorization` set to `true`. In the request, provide a new `tracking_id` for the confirmation operation and the `original_tracking_id` of the original payment operation. If you don't provide the `amount`, the platform confirms the total original amount. You can also provide the `amount` to confirm a total, partial, or greater amount. Refer to the [Payment methods](doc:payment-methods) guide for additional information. This endpoint generates a [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Create transfer](https://developers.pismo.io/pismo-docs/reference/post-transfers.md): Create a transfer operation between two accounts on the Pismo platform. With this endpoint, you have the following additional options. - Specify the `authentication` method and details. - Set `pre_authorization` to `true` for operations that require additional confirmation and then call the [Confirm pre-authorized transfer](ref:post-transfers-confirm) endpoint. - Set `validation_rules` in the `From` object to control the rules in this flow, such as disabling a rule, changing the response code and denial code, and forcing a rule. Refer to the [Payment methods](doc:payment-methods) guide for additional information. This endpoint generates a [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Cancel transfer](https://developers.pismo.io/pismo-docs/reference/post-transfers-cancel.md): Cancel an existing transfer operation. If you don't provide the `amount`, the platform cancels the total original amount. You can also provide the `amount` to cancel a total or partial amount. Refer to the [Payment methods](doc:payment-methods) guide for additional information. This endpoint generates a [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Confirm pre-authorized transfer](https://developers.pismo.io/pismo-docs/reference/post-transfers-confirm.md): Confirm a pre-authorized transfer operation. Use this endpoint only if the created transfer operation had the `pre_authorization` set to `true`. In the request, provide a new `tracking_id` for the confirmation operation and the `original_tracking_id` of the original transfer operation. If you don't provide the `amount`, the platform confirms the total original amount. You can also provide the `amount` to confirm a total, partial, or greater amount. Refer to the [Payment methods](doc:payment-methods) guide for additional information. This endpoint generates a [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Transfer funds](https://developers.pismo.io/pismo-docs/reference/post-payments-v1-payments.md): **Note:** Enhanced features and improvements are available in the [Payment methods](doc:payment-methods) API, the new application interface for non-card network authorizations. This Transfer funds endpoint is still supported, but all new feature developments will be available only in the Payment methods API. For more information, contact your Pismo representative. ----- Transfer funds between a source (`from`) and destination (`to`). The `to` and `from` objects contain information about one of the following payment methods: 1. **`account`** - Platform merchant or customer account 2. **`card`** - Credit card stored in a digital wallet, known as a **card on file** 3. **`custom_info`** - Custom payment information, usually about an external account 4. **`merchant`** - Platform merchant ### Transfers You can use this endpoint to make the following types of transfers: * Pismo platform account to Pismo platform account (P2P) * Pismo platform account to merchant account (P2M) * Card to platform account (P2P with card) * Pismo platform account to merchant account with card (P2M with card) * Merchant account to merchant account (M2M) * Cashin * Cashin with card * Cashout * Cashout with card * Payment, which requires token (code) from [creating payment request](ref:payment-requests) See the Examples drop-down menu for sample payloads for each of these transfer types. See the [Make transfer](doc:make-transfer) guide for more details on these transfer type use cases. This endpoint generates an [Authorization created](https://developers.pismo.io/events/docs/authorization-authorization-event-1) event. **Note:** This endpoint requires an account-specific access token. Getting an account token requires you to call the [Get OpenID access token](ref:post-passport-v1-oauth2-token) endpoint with an account ID. Tokens can expire quickly, which can result in an Unauthorized message. - [Cancel transfer funds](https://developers.pismo.io/pismo-docs/reference/post-payments-v2-cancel.md): **Note:** Enhanced features and improvements are available in the [Payment methods](doc:payment-methods) API, the new application interface for non-card network authorizations. This Cancel transfer funds endpoint is still supported, but all new feature developments will be available only in the Payment methods API. For more information, contact your Pismo representative. ----- Cancel a previously authorized transfer made with the [Transfer funds](ref:post-payments-v1-payments) endpoint. Pass one of two parameters (but not both) returned from the Transfer funds endpoint to identify the transfer to be canceled: - The `tracking_id` (pass as `original_tracking_id`) - The credit or debit authorization ID (pass as `authorization_id`). For an external operation, the acquirer response is returned in the `metadata` field. If no processing codes are specified, the original authorization's reversal processing codes are used. This endpoint generates an [Authorization cancelled](https://developers.pismo.io/events/docs/authorization-authorization-cancellation-event-1) event. For additional information, see the [Cancel transfer](doc:cancel-transfer) guide. - [Force operation](https://developers.pismo.io/pismo-docs/reference/post-payments-v1-force.md): Force a credit or debit operation in the specified account using the `account_id`, the `processing_code`, and the `amount` provided. This operation directly impacts the balance but does not perform any of the validations that are done in the [Transfer funds](ref:post-payments-v1-payments) endpoint, such as validating the account status, account balance, and flex controls. This endpoint generates an [Authorization created](https://developers.pismo.io/events/docs/authorization-authorization-event-1) event with authorization > type "FORCE". For additional information, see the [Force operation](doc:force-operation) guide. ## Forced credit example Assuming that `processing_code` "090907" is defined as credit type, the following payload executes a forced credit operation: ```json { "amount": 12.34, "account_id": 2417, "processing_code": "090907", "descriptor": "Cashback credit", "original_authorization": { "id": 123, "type": "PLATFORM" }, "metadata": { "my-custom-key": "my-custom-info" } } ``` - [Cancel forced operation](https://developers.pismo.io/pismo-docs/reference/post-payments-v1-force-cancel.md): Cancel forced operation. Only works with forced operations and with the total amount. This endpoint generates an [Authorization cancelled](https://developers.pismo.io/events/docs/authorization-authorization-cancellation-event-1) event with authorization > type "FORCE". - [Block amount](https://developers.pismo.io/pismo-docs/reference/post-payments-v1-hold-funds-block.md): Block amount in an account. This endpoint generates [Authorization created](https://developers.pismo.io/events/docs/authorization-authorization-event-1) and [Account balance changed](https://developers.pismo.io/events/docs/availables-change-available-1) events. See the [Hold funds](doc:hold-funds) guide for more details. - [Unblock held amount](https://developers.pismo.io/pismo-docs/reference/post-payments-v1-hold-funds-unblock.md): Unblock held amount in an account. This endpoint generates [Authorization created](https://developers.pismo.io/events/docs/authorization-authorization-event-1) and [Account balance changed](https://developers.pismo.io/events/docs/availables-change-available-1) events. See the [Hold funds](doc:hold-funds) guide for more details. - [Transfer held amount](https://developers.pismo.io/pismo-docs/reference/post-payments-v1-hold-funds-transfer.md): Transfer a previously held amount from an account. This endpoint generates the [Authorization created](https://developers.pismo.io/events/docs/authorization-authorization-event-1) and [Account balance changed](https://developers.pismo.io/events/docs/availables-change-available-1) events. See the [Hold funds](doc:hold-funds) guide for more details. - [Cancel transfer of held amount](https://developers.pismo.io/pismo-docs/reference/post-payments-v1-hold-funds-transfer-cancel.md): Cancel transfer of a previously held amount from an account. This endpoint generates the [Authorization created](https://developers.pismo.io/events/docs/authorization-authorization-event-1) and [Account balance changed](https://developers.pismo.io/events/docs/availables-change-available-1) events. See the [Hold funds](doc:hold-funds) guide for more details. - [Create payment request](https://developers.pismo.io/pismo-docs/reference/post-payments-v1-payment-requests.md): Create a new payment request. Once created, call the [Transfer funds](ref:post-payments-v1-payments) endpoint to execute the payment. For additional information, see the [Payment requests](doc:payment-requests) guide. - [List payment requests](https://developers.pismo.io/pismo-docs/reference/get-payments-v1-payment-requests.md): List previously created payment requests. Filter with either (but not both) account ID in `from` or `to`. - [Create installments payment](https://developers.pismo.io/pismo-docs/reference/post-payments-v1-installments.md): Create a new installments payment. This endpoint generates the [Authorization created](https://developers.pismo.io/events/docs/authorization-authorization-event-1) event. - [Cancel installments payment](https://developers.pismo.io/pismo-docs/reference/post-payments-v1-installments-cancel.md): Cancel an existing installments payment. This endpoint generates the [Authorization created](https://developers.pismo.io/events/docs/authorization-authorization-event-1) event. - [Create simulation](https://developers.pismo.io/pismo-docs/reference/post-v1-simulation.md): Create a simulation. Prior to calling this endpoint to create a simulation, you must create a simulation configuration via the [Create simulation config](ref:simulationconfigs) endpoint. Refer to the [Simulation service](doc:simulation-service) guide for additional information. - [Create single schedule](https://developers.pismo.io/pismo-docs/reference/post-v1-create-single-schedule.md): Create a single schedule, which executes a simple payment operation on a single account. Configure the schedule's execution frequency and other details in the `schedule_details` field. In some cases, due to errors and retries, execution of the scheduled transaction might occur on the following day instead of the originally scheduled date. To address this, the `allow_execution_after_day_change` flag in `schedule_details` enables you to pre-authorize execution of the scheduled transaction on the next day. This flag must be set to `true` for schedules that are set to be executed at the end of the day (after 11:30pm UTC). If the schedule is not executed on the expected day for any reason, and this field isn't set to `true`, the schedule is not executed and is marked as `EXECUTED_WITH_ERROR_NEXT_DAY_NOT_ALLOWED`. This endpoint generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `CREATED`. Each execution of the schedule also generates the [Scheduled payment executed](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-execution-1) event. Refer to the [Payment scheduler](doc:payment-scheduler) guide for more information. - [Create transfer schedule](https://developers.pismo.io/pismo-docs/reference/post-v1-create-transfer-schedules.md): Create a transfer schedule, which represents a transfer operation from a parent (main) account to one or more associated child accounts. Configure the schedule's execution frequency and other details in the `schedule_details` field. Transfer amounts can be set as follows. - If you fill out the `strategy` field, the platform uses the strategy logic to determine transfer amounts. - If you don't fill out the `strategy` field, you must specify the `amount` field for each transfer in the `transfers` array. In some cases, due to errors and retries, execution of the scheduled transaction might occur on the following day instead of the originally scheduled date. To address this, the `allow_execution_after_day_change` flag in `schedule_details` enables you to pre-authorize execution of the scheduled transaction on the next day. This flag must be set to `true` for schedules that are set to be executed at the end of the day (after 11:30pm UTC). If the schedule is not executed on the expected day for any reason, and this field isn't set to `true`, the schedule is not executed and is marked as `EXECUTED_WITH_ERROR_NEXT_DAY_NOT_ALLOWED`. This endpoint generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `CREATED`. Each execution of the schedule also generates the [Scheduled payment executed](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-execution-1) event. Refer to the [Payment scheduler](doc:payment-scheduler) guide for more information. - [Create pre-schedule](https://developers.pismo.io/pismo-docs/reference/post-pre-schedules.md): Create a pre-schedule, which is executed by a direct call from the Pismo platform at the end of the closing cycle. To configure execution of a pre-schedule, contact your Pismo representative or call the [Execute pre-schedule](ref:post-execute-pre-schedule) endpoint. This endpoint generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `CREATED`. Once the pre-schedule is created, its execution generates the following events. - First execution of the pre-schedule on the start date generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `IN_PROGRESS`. - Last execution of the pre-schedule on the end date generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `COMPLETED`. - Each execution of the pre-schedule also generates the [Scheduled payment executed](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-execution-1) event with the corresponding execution status. Refer to the [Payment scheduler](doc:payment-scheduler) guide for more information. - [Create bulk pre-schedules](https://developers.pismo.io/pismo-docs/reference/post-bulk-pre-schedules.md): Create multiple pre-schedules in a single request. This request triggers an asynchronous process to create the pre-schedules. Once processing is complete, the [Bulk pre-schedules created](https://developers.pismo.io/events/docs/scheduler-payments-bulk-pre-scheduled-payments-1) event is sent with the result of the operation. Pre-schedule is a type of schedule that is executed by a direct call from the Pismo platform at the end of the closing cycle. To configure a pre-schedule execution, contact your Pismo representative or call the [Execute pre-schedule](ref:post-execute-pre-schedule) endpoint. This endpoint generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `CREATED`. Once the pre-schedule is created, its execution generates the following events. - First execution of the pre-schedule on the start date generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `IN_PROGRESS`. - Last execution of the pre-schedule on the end date generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `COMPLETED`. - Each execution of the pre-schedule also generates the [Scheduled payment executed](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-execution-1) event with the corresponding execution status. Refer to the [Payment scheduler](doc:payment-scheduler) guide for more information. - [Execute pre-schedule](https://developers.pismo.io/pismo-docs/reference/post-execute-pre-schedule.md): Execute the pre-schedule. This endpoint generates the [Scheduled payment executed](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-execution-1) event. - [List account schedules](https://developers.pismo.io/pismo-docs/reference/get-all-schedules.md): List account schedules with paging and filter options. - [List schedule executions](https://developers.pismo.io/pismo-docs/reference/get-schedule-executions.md): List account schedule executions. - [Get schedule](https://developers.pismo.io/pismo-docs/reference/get-schedule.md): Get account schedule by schedule ID. - [Update schedule](https://developers.pismo.io/pismo-docs/reference/patch-schedule.md): Update account schedule by schedule ID. - [Cancel schedule](https://developers.pismo.io/pismo-docs/reference/delete-schedule.md): Cancel account schedule by schedule ID. This endpoint generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `CANCELED`. - [Create bulk single schedules](https://developers.pismo.io/pismo-docs/reference/post-v1-create-bulk-single-schedules.md): Create multiple single schedules in a single request. This request triggers an asynchronous process to create the schedules. Once processing is complete, the [Bulk single schedules created](https://developers.pismo.io/events/docs/scheduler-payments-bulk-scheduled-payments-1) event is sent with the result of the operation. This endpoint accepts a `defaults` object that can be used to set common values for all schedules in the request. Individual schedules can override any default value by specifying the field in their own definition. In some cases, due to errors and retries, execution of the scheduled transaction might occur on the following day instead of the originally scheduled date. To address this, the `allow_execution_after_day_change` flag in `schedule_details` enables you to pre-authorize execution of the scheduled transaction on the next day. This flag must be set to `true` for schedules that are set to be executed at the end of the day (after 11:30pm UTC). If the schedule is not executed on the expected day for any reason, and this field isn't set to `true`, the schedule is not executed and is marked as `EXECUTED_WITH_ERROR_NEXT_DAY_NOT_ALLOWED`. This endpoint generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `CREATED`. Each execution of the schedule also generates the [Scheduled payment executed](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-execution-1) event. Refer to the [Payment scheduler](doc:payment-scheduler) guide for more information. - [Create bulk transfer schedules](https://developers.pismo.io/pismo-docs/reference/post-v1-create-bulk-transfer-schedules.md): Create multiple transfer schedules in a single request. This request triggers an asynchronous process to create the schedules. Once processing is complete, the [Bulk transfer schedules created](https://developers.pismo.io/events/docs/scheduler-payments-bulk-transfer-scheduled-payments-1) event is sent with the result of the operation. This endpoint accepts a `defaults` object that can be used to set common values for all schedules in the request. Individual schedules can override any default value by specifying the field in their own definition. Transfer amounts can be set as follows. - If you fill out the `strategy` field, the platform uses the strategy logic to determine transfer amounts. - If you don't fill out the `strategy` field, you must specify the `amount` field for each transfer in the `transfers` array, or provide a default amount in `transfer_defaults`. In some cases, due to errors and retries, execution of the scheduled transaction might occur on the following day instead of the originally scheduled date. To address this, the `allow_execution_after_day_change` flag in `schedule_details` enables you to pre-authorize execution of the scheduled transaction on the next day. This flag must be set to `true` for schedules that are set to be executed at the end of the day (after 11:30pm UTC). If the schedule is not executed on the expected day for any reason, and this field isn't set to `true`, the schedule is not executed and is marked as `EXECUTED_WITH_ERROR_NEXT_DAY_NOT_ALLOWED`. This endpoint generates the [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1) event with the `status` field set to `CREATED`. Each execution of the schedule also generates the [Scheduled payment executed](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-execution-1) event. Refer to the [Payment scheduler](doc:payment-scheduler) guide for more information. - [Create org configuration](https://developers.pismo.io/pismo-docs/reference/post-config-by-tenant.md): Create a payment methods configuration for an authorization at the organization (org) level. This level can be used as a default configuration for all programs and accounts in this org. There can be only one org configuration. New creation attempts for the same org receive a conflict response. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get org configuration](https://developers.pismo.io/pismo-docs/reference/get-config-by-tenant.md): Get a payment methods configuration at the organization level. Note that the organization and account information is pulled from the access token. - [Replace org configuration](https://developers.pismo.io/pismo-docs/reference/put-config-by-tenant.md): Update a payment methods configuration at the organization level. This operation updates the entire configuration, so all fields must be sent to avoid data loss. - [Update org configuration](https://developers.pismo.io/pismo-docs/reference/patch-config-by-tenant.md): Update a payment methods configuration at the organization level. This operation updates only the fields with the passed values. - [Delete org configuration](https://developers.pismo.io/pismo-docs/reference/delete-config-by-tenant.md): Delete a payment methods configuration at the organization level. - [Create program configuration](https://developers.pismo.io/pismo-docs/reference/post-config-by-program.md): Create a payment methods configuration at the program level. This level can be used as a default configuration for all accounts in this program and at a more granular level than org. There can be only one program configuration. New creation attempts for the same program receive a conflict response. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get program configuration](https://developers.pismo.io/pismo-docs/reference/get-config-by-program.md): Get the Payment methods configuration on the program level. - [Replace program configuration](https://developers.pismo.io/pismo-docs/reference/put-config-by-program.md): Update a payment methods configuration at the program level. This operation updates the entire configuration, so all fields must be passed to avoid data loss. - [Update program configuration](https://developers.pismo.io/pismo-docs/reference/patch-config-by-program.md): Update a payment methods configuration at the program level. This operation updates only the fields with the provided values. - [Delete program configuration](https://developers.pismo.io/pismo-docs/reference/delete-config-by-program.md): Delete a payment methods configuration at the program level. - [Create account configuration](https://developers.pismo.io/pismo-docs/reference/post-config-by-account.md): Create a payment methods configuration at the account level. This is the most granular level allowed and can be used to customize a specific account. There can be only one configuration by account. New creation attempts for the same account receive a conflict response. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get account configuration](https://developers.pismo.io/pismo-docs/reference/get-config-by-account.md): Get a payment methods configuration at the account level. - [Replace account configuration](https://developers.pismo.io/pismo-docs/reference/put-config-by-account.md): Update a payment methods configuration at the account level. This operation updates the entire configuration, so all fields must be sent to avoid data loss. - [Update account configuration](https://developers.pismo.io/pismo-docs/reference/patch-config-by-account.md): Update a payment methods configuration at the account level. This operation updates only the fields with the provided values. - [Delete account configuration](https://developers.pismo.io/pismo-docs/reference/delete-config-by-account.md): Delete a payment methods configuration at the account level. - [Get configuration by hierarchy](https://developers.pismo.io/pismo-docs/reference/get-config-by-priority.md): Get a payment methods configuration based on the hierarchy from the most granular to the least granular (account > program > org). **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Create org acceptance configuration](https://developers.pismo.io/pismo-docs/reference/post-acceptance-by-tenant.md): Create acceptance configuration for a processing code operation on the organization level. This level can be used as a default configuration for all programs and accounts in this org. There is always only one configuration by operation by org. New creation attempts for the same operation receive a conflict response. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Replace org acceptance configuration](https://developers.pismo.io/pismo-docs/reference/put-acceptance-by-tenant.md): Update acceptance configuration for a processing code operation on the organization level. This operation updates the entire configuration, so all fields must be passed to avoid data loss. - [Update org acceptance configuration](https://developers.pismo.io/pismo-docs/reference/patch-acceptance-by-tenant.md): Update acceptance configuration for a processing code operation on the organization level. This operation updates only the fields with the passed values. - [Get org acceptance configuration](https://developers.pismo.io/pismo-docs/reference/get-acceptance-by-tenant.md): Get acceptance configuration for a processing code operation on the organization level. - [Delete org acceptance configuration](https://developers.pismo.io/pismo-docs/reference/delete-acceptance-config-by-tenant.md): Delete acceptance configuration for a processing code operation on the organization level. - [Create program acceptance configuration](https://developers.pismo.io/pismo-docs/reference/post-acceptance-by-program.md): Create acceptance configuration for a processing code operation on the program level. This level can be used as a default configuration for all accounts in this program and at a more granular level than org. There is always only one configuration by operation by program. New creation attempts for the same operation receive a conflict response. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Replace program acceptance configuration](https://developers.pismo.io/pismo-docs/reference/put-acceptance-by-program.md): Update acceptance configuration for a processing code operation on the program level. This operation updates the entire configuration, so all fields must be sent to avoid data loss. - [Update program acceptance configuration](https://developers.pismo.io/pismo-docs/reference/patch-acceptance-by-program.md): Update acceptance configuration for a processing code operation on the program level. This operation updates only the fields with the provided values. - [Get program acceptance configuration](https://developers.pismo.io/pismo-docs/reference/get-acceptance-by-program.md): Get acceptance configuration for a processing code operation on the program level. - [Delete program acceptance configuration](https://developers.pismo.io/pismo-docs/reference/delete-acceptance-config-by-program.md): Delete acceptance configuration for a processing code operation on the program level. - [Create account acceptance configuration](https://developers.pismo.io/pismo-docs/reference/post-acceptance-by-account.md): Create acceptance configuration for a processing code operation on the account level. This is the most granular level allowed and can be used to customize a specific account. There is always only one configuration by operation by account. New creation attempts for the same operation receive a conflict response. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Replace account acceptance configuration](https://developers.pismo.io/pismo-docs/reference/put-acceptance-by-account.md): Update acceptance configuration for a processing code operation on the account level. This operation updates the entire configuration, so all fields must be sent to avoid data loss. - [Update account acceptance configuration](https://developers.pismo.io/pismo-docs/reference/patch-acceptance-by-account.md): Update acceptance configuration for a processing code operation on the account level. This operation updates only the fields with the provided values. - [Get account acceptance configuration](https://developers.pismo.io/pismo-docs/reference/get-acceptance-by-account.md): Get acceptance configuration for a processing code operation on the account level. - [Delete account acceptance configuration](https://developers.pismo.io/pismo-docs/reference/delete-acceptance-config-by-account.md): Delete acceptance configuration for a processing code operation on the account level. - [Get acceptance configuration by hierarchy](https://developers.pismo.io/pismo-docs/reference/get-acceptance-by-priority.md): Get acceptance configuration for a processing code operation based on the hierarchy from the most granular to the least granular (account > program > org). **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Create org rule model](https://developers.pismo.io/pismo-docs/reference/post-org-rule-model.md): Create a rule model at the organizational level for a processing code. A rule model swaps one processing code for another if certain conditions are met. For example, you may want to use a custom processing code if the merchant is Apple. Rule models cannot be shared between organizations. Refer to [Processing codes](doc:processing-codes-and-transaction-types) for more information on processing codes and rule models. Call the following to attach a rule model to an organization, program, or account. - [Apply rule model to org](ref:post-org-model-config) - [Apply rule model to program](ref:post-program-model-config) - [Apply rule model to account](ref:post-account-model-config) - [Get rule model](https://developers.pismo.io/pismo-docs/reference/get-rule-model.md): Get the rule model identified in the path. - [Replace rule model](https://developers.pismo.io/pismo-docs/reference/put-rule-model.md): Replace the rule model identified in the path. - [Create model list](https://developers.pismo.io/pismo-docs/reference/post-org-model-list.md): Create data for a rule model to evaluate. A model list contains values to evaluate in a rule model. To use the list, pass its ID as a `data` field's value in a `condition` when you [create a rule model](ref:post-org-rule-model). For example, you can create a model list to capture purchases made through designated merchants with the `MERCHANT_NAME_LIST` condition type. The list could look like this: `["APPLE", "MICROSOFT", "BEST BUY"]`, and be used like this: 
 ...   {     "type": "MERCHANT_NAME_LIST",     "operator": "contains",     "data": "15bda43f-5f6d-4681-8c09-853de8b9479d"  ## Model list ID   } ...
- [Get model list](https://developers.pismo.io/pismo-docs/reference/get-model-list.md): Get the model list identified in the path. - [Update model list](https://developers.pismo.io/pismo-docs/reference/patch-model-list.md): Update the model list identified in the path, either adding new values or deleting values. - [Replace model list](https://developers.pismo.io/pismo-docs/reference/put-org-model-list.md): Replace a model list to evaluate a rule that the platform applies at the organization level, overriding the old list with the list being sent on this request. - [Apply rule model to org](https://developers.pismo.io/pismo-docs/reference/post-org-model-config.md): Apply rule model to an organization. - [Get org rule model](https://developers.pismo.io/pismo-docs/reference/get-org-model-config.md): Get an organization's rule model - [Replace org rule model](https://developers.pismo.io/pismo-docs/reference/put-org-model-config.md): Replace the organization rule model - [Apply rule model to program](https://developers.pismo.io/pismo-docs/reference/post-program-model-config.md): Apply a rule model to a specified program. - [Get program rule model](https://developers.pismo.io/pismo-docs/reference/get-program-model-config.md): Get a program rule model - [Replace program rule model](https://developers.pismo.io/pismo-docs/reference/put-program-model-config.md): Replace the program rule model - [Apply rule model to account](https://developers.pismo.io/pismo-docs/reference/post-account-model-config.md): Apply rule model to an account - [Get account rule model](https://developers.pismo.io/pismo-docs/reference/get-account-model-config.md): Get account rule model - [Replace account rule model](https://developers.pismo.io/pismo-docs/reference/put-account-model-config.md): Replace an account rule model - [Create transaction type](https://developers.pismo.io/pismo-docs/reference/postsetuptransactiontype.md): Create a new transaction type. Examples of transaction types include cash-in and cash-out. For the list of transaction types on the Pismo platform, refer to [Standard processing codes](doc:processing-codes-and-transaction-types#standard-processing-codes). This endpoint generates the [Transaction type created](https://developers.pismo.io/events/docs/transaction-types-creation-1) event. For information on creating and managing processing codes and transaction types, refer to [Processing codes and transaction types](doc:processing-codes-and-transaction-types) and [Payments configurations](doc:payments-configurations). - [List transaction types](https://developers.pismo.io/pismo-docs/reference/searchtransactiontypes.md): List transaction types that match the search parameters. If no search parameters are given, then all transaction types are returned. - [Get transaction type](https://developers.pismo.io/pismo-docs/reference/gettransactiontypebyid.md): Get a transaction type, given the transaction type ID. - [Update transaction type](https://developers.pismo.io/pismo-docs/reference/patchtransactiontype.md): Updates a transaction type description, given the transaction type ID. - [Update program transaction type description](https://developers.pismo.io/pismo-docs/reference/patchprogramtransactiontype.md): Update the description of a transaction type for a specific program. - [Create transaction flow](https://developers.pismo.io/pismo-docs/reference/posttransactionflow.md): Creates a configuration linking a transaction type with a processing code. See [Processing codes and transaction types](doc:processing-codes-and-transaction-types) and [Payments configurations](doc:payments-configurations) for information on processing codes and transaction types, how to create them, and map them to each other. - [List transaction flows](https://developers.pismo.io/pismo-docs/reference/searchtransactionflows.md): List transaction flow configurations that link transaction types and processing codes. See [Processing codes and transaction types](doc:processing-codes-and-transaction-types) and [Payments configurations](doc:payments-configurations) for information on processing codes and transaction types, how to create them, and map them to each other. - [Update transaction flow](https://developers.pismo.io/pismo-docs/reference/patchtransactionflow.md): Update `key` or `custom_key` for the relation between processing code and transaction type ID. You can only use this endpoint to update a transaction flow that is already created. - [Get transaction](https://developers.pismo.io/pismo-docs/reference/gettransactionbyid.md): Get a specific transaction by its ID. You can use the [List transactions](ref:searchtransactions) endpoint to search for a transaction and get its ID. - [List transactions](https://developers.pismo.io/pismo-docs/reference/listtransactions.md): List transactions without their metadata. If you provide at least one of the following parameters, the `eventDateStart` parameter is optional. - `id` - `authorizationId` - `authorizationIds` - `statementId` - `authorizationTrackingId` - `numberOfLatestTransactions` If you don't provide any of the above parameters, you must include the `eventDateStart` parameter, and the maximum allowed query range is 90 days. - [Get transaction count](https://developers.pismo.io/pismo-docs/reference/searchtranscationmetadatacount.md): Returns the number of transactions that match the given search parameters. - [List audit records](https://developers.pismo.io/pismo-docs/reference/listauditrecords.md): Returns paginated audit records based on filter parameters. - [Create hierarchy](https://developers.pismo.io/pismo-docs/reference/post-hierarchies.md): Creates a hierarchy. This can be used generically, but it's typically used to create business hierarchies along territorial lines: headquarters > countries > regions > branches, and so on. This endpoint generates a [Corporate hierarchy created](https://developers.pismo.io/events/docs/corporate-hierarchy-creation-1) event. See the [Data and reporting](doc:data-reporting-overview) guide for more information on events and setting up event notifications. For more information on hierarchies, see [Hierarchy](doc:hierarchies-2). - [List hierarchies](https://developers.pismo.io/pismo-docs/reference/get-hierarchies.md): Lists hierarchies and their levels. - [Get hierarchy](https://developers.pismo.io/pismo-docs/reference/gethierarchy.md): Retrieves a hierarchy by its ID. - [Update hierarchy](https://developers.pismo.io/pismo-docs/reference/patch-hierarchy.md): Updates a hierarchy's name. - [Create division](https://developers.pismo.io/pismo-docs/reference/post-division-v2.md): Creates a division by level and hierarchy ID. To use the holidays defined in an administrative division, specify its ID in `administrative_division_id` to link your division. This endpoint generates a [Corporate division created](https://developers.pismo.io/events/docs/corporate-division-creation-2) event. - [List division](https://developers.pismo.io/pismo-docs/reference/list-division-v2.md): Lists divisions by hierarchy ID or level ID. Only one of the parameters should be provided with the request. Providing both generates an error. - [Get division](https://developers.pismo.io/pismo-docs/reference/get-division-by-code-v2.md): Retrieves a division by its division code. - [Update division](https://developers.pismo.io/pismo-docs/reference/patch-division-v2.md): Updates a division. Only provided fields are updated. Other fields are left unchanged. This endpoint generates a [Corporate division updated](https://developers.pismo.io/events/docs/corporate-division-change-2) event. - [Create transaction banking account](https://developers.pismo.io/pismo-docs/reference/post-account.md): Creates a transaction banking account. For details, refer to [Transaction banking accounts](doc:corporate-accounts). This endpoint generates the following events: - [Corporate account created](https://developers.pismo.io/events/docs/corporate-corporate-account-creation-1). - [Account application created](https://developers.pismo.io/events/docs/onboarding-succeeded-1) For more information about events and setting up event notifications, refer to the [Data and reporting overview](doc:data-reporting-overview) guide. - [Close transaction banking account](https://developers.pismo.io/pismo-docs/reference/post-accounts-accountid-close.md): Close a transaction banking account and all of its children. Book balance and earmark balance must be zero. This endpoint generates an [Account status changed](https://developers.pismo.io/events/docs/account-status-change-2) event. **NOTE**: This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - [Get transaction banking account information](https://developers.pismo.io/pismo-docs/reference/get-accounts.md): Get the information for a transaction banking account. **NOTE**: This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - [Update transaction banking account](https://developers.pismo.io/pismo-docs/reference/patch-account.md): Update a transaction banking account. **NOTE**: This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. This endpoint generates the following events: - [Corporate account updated](https://developers.pismo.io/events/docs/corporate-corporate-account-change-1) - [Account status changed](https://developers.pismo.io/events/docs/account-status-change-2) - [Update transaction banking account status](https://developers.pismo.io/pismo-docs/reference/patch-accounts-accountid-status-v2.md): Update the status of a transaction banking account and the statuses of all the account's children. This endpoint generates the following event: - [Account status changed](https://developers.pismo.io/events/docs/account-status-change-2). For more information on account status and reasons, see [Manage account statuses](doc:managing-account-statuses). Note: This endpoint requires an account token — an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - [Transfer transaction banking account ownership](https://developers.pismo.io/pismo-docs/reference/patch-accounts-accountid-entity.md): Assign a new owner to a transaction banking account. If the new owner already exists within the organization, it's linked to the account. If not, a new entity is created and linked to the account. The previous account owner and all other customers linked to the account are deactivated. This endpoint generates an [Account owner changed](https://developers.pismo.io/events/docs/account-account-owner-change-1) event. **NOTE**: This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - [Roll back transaction banking account status](https://developers.pismo.io/pismo-docs/reference/patch-accounts-accountid-status-rollback-v2.md): Roll back an account from its final status. Note: You can only change the account status from its final status to one that is both not final and not in a dormant state. This endpoint generates an [Account status changed](https://developers.pismo.io/events/docs/account-status-change-2) event. For more information on account statuses, refer to [Manage account statuses](doc:managing-account-statuses). **NOTE**: This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - [List transaction banking account status reasons](https://developers.pismo.io/pismo-docs/reference/v1-get-account-status-reason.md): List transaction banking account status reasons. - [Force close transaction banking account](https://developers.pismo.io/pismo-docs/reference/post-accounts-accountid-force-close.md): Initiates an asynchronous force‑closure of a transaction banking account by placing a closure instruction in the processing queue. All business rules, including balance checks, earmark verification, and status validation, are evaluated during asynchronous execution rather than when the request is submitted. **NOTE**: * This endpoint requires an account token, an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. * Calling this endpoint generates a [Force account closure succeeded](https://developers.pismo.io/events/docs/corporate-force-account-closure-1) event. - [Create account balance history config v1](https://developers.pismo.io/pismo-docs/reference/post-account-balance-history-configuration.md): Create an account balance history configuration by division code. The configuration becomes effective on the day after the cycle closing time plus the cycle event delay. Example: - Division timezone: `UTC` - Create account balance history configuration is called at: `2023-05-01T18:00:00Z` - Account balance history configuration `cycle_closing_time` is: `22:00:00` - Account balance history configuration `cycle_event_delay` is: `10` - Account balance history configuration starts at `2023-05-01T22:10:00Z` This endpoint generates an [Account balance history configuration created](https://developers.pismo.io/events/docs/account-balances-balance-history-config-creation-1) event. - [Get account balance history config v1](https://developers.pismo.io/pismo-docs/reference/get-account-balance-history-configuration.md): Get the current account balance history configuration by division code. Also returns previous configurations if you pass the query parameter `showPrevious` set to `true`. - [Update account balance history config v1](https://developers.pismo.io/pismo-docs/reference/patch-account-balances-history-configuration.md): Update the account balance history configuration for a division code. If this endpoint is called when the current datetime is greater than `cycle_config_validity.start`, the new configuration is valid only after the two-cycle closing date. Example: - division timezone: UTC - Update account balance history configuration called at: `2023-05-01T18:00:00Z` - current cycle closing time: 22:00:00 - current cycle closing date: 2023-04-30 (from `2023-04-30T22:00:00Z` to `2023-05-01T22:00:00Z`) - cycle config validity start datetime of the new config: `2023-05-02T22:00:00Z` - current config stays valid until `2023-05-02T22:00:00Z` If this endpoint is called when the current datetime is less than or equal to `cycle_config_validity.start` of the most recent configuration, the new configuration overrides the the most recent configuration. Example: - division timezone: UTC - Update account balance history configuration called at: `2023-05-01T19:00:00Z` - Cycle config validity start datetime of the most recent configuration: `2023-05-02T22:00:00Z` - New config overrides the most recent configuration settings, keeping the same cycle config validity start date: `2023-05-01T22:00:00Z` This endpoint generates an [Account balance history configuration changed](https://developers.pismo.io/events/docs/account-balances-balance-history-config-change-1) event. - [Get transaction banking account balance](https://developers.pismo.io/pismo-docs/reference/get-account-balances.md): Get balances associated with a specific account. These balances include available, credit, debit balance, and so on. - [Get transaction banking account balance history](https://developers.pismo.io/pismo-docs/reference/get-account-balance-history.md): Get the balance history for a transaction banking account. - [Create account balance history config v2](https://developers.pismo.io/pismo-docs/reference/post-account-balance-history-configv2.md): Create an account balance history configuration by division, organization, or program ID. The configuration becomes effective on the day after the cycle closing time plus the cycle event delay. Example: - Division timezone: `UTC` - Create account balance history configuration is called at: `2023-05-01T18:00:00Z` - Account balance history configuration `cycle_closing_time` is: `22:00:00` - Account balance history configuration `cycle_event_delay` is: `10` - Account balance history configuration starts at `2023-05-01T22:10:00Z` This endpoint generates an [Account balance history configuration created](https://developers.pismo.io/events/docs/account-balances-balance-history-config-creation-1) event. - [List account balance history config v2](https://developers.pismo.io/pismo-docs/reference/list-account-balance-history-configv2.md): List account balance history configurations by division, organization, or program ID. - [Get account balance history config by ID v2](https://developers.pismo.io/pismo-docs/reference/get-account-balance-history-config-by-id-v2.md): Get the current account balance history configuration by ID. Also returns previous configurations if you pass the query parameter `showPrevious` set to `true`. - [Update account balance history config v2](https://developers.pismo.io/pismo-docs/reference/patch-account-balances-history-configv2.md): Update the account balance history configuration. When you call this endpoint after `cycle_config_validity.start`, the new configuration is valid only after the two-cycle closing date. Example: - division timezone: UTC - Update account balance history configuration called at: `2023-05-01T18:00:00Z` - current cycle closing time: 22:00:00 - current cycle closing date: 2023-04-30 (from `2023-04-30T22:00:00Z` to `2023-05-01T22:00:00Z`) - cycle config validity start datetime of the new config: `2023-05-02T22:00:00Z` - current config stays valid until `2023-05-02T22:00:00Z` If this endpoint is called when the current datetime is less than or equal to `cycle_config_validity.start` of the most recent configuration, the new configuration overrides the the most recent configuration. Example: - division timezone: UTC - Update account balance history configuration called at: `2023-05-01T19:00:00Z` - Cycle config validity start datetime of the most recent configuration: `2023-05-02T22:00:00Z` - New config overrides the most recent configuration settings, keeping the same cycle config validity start date: `2023-05-01T22:00:00Z` This endpoint generates an [Account balance history configuration changed](https://developers.pismo.io/events/docs/account-balances-balance-history-config-change-1) event. - [Get account balance history config by target type v2](https://developers.pismo.io/pismo-docs/reference/get-account-balance-history-config-by-target-v2.md): Get the latest valid account balance history configuration for a specific target (organization, program, or division). - [Post payment](https://developers.pismo.io/pismo-docs/reference/corporate-v2-post-payments.md): Enable users to submit a payment to the Pismo platform. It supports posting debits and credits to an account, as well as facilitating fund transfers between accounts. For details about payment operations, see [Payment overview](doc:payment-overview) and [Corporate Banking Launch Reference](doc:corporate-banking-launch-reference). NOTES: - This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - To get the correct reason IDs, refer to the [List account status reasons](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-accounts-status-reasons) endpoint.
Each payment operation created generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) - [Accounting entry created](https://developers.pismo.io/events/docs/accounting-entry-creation-1) - If flex controls are configured, a [Flex control evaluated](https://developers.pismo.io/events/docs/rules-evaluation-requested-1) event is triggered. See [Data and reporting](doc:data-reporting-overview) for more information on events and setting up event notifications. - [Confirm payment](https://developers.pismo.io/pismo-docs/reference/corporate-v2-post-confirm-payments.md): Confirm an existing payment operation. NOTE: - This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) See [Data and reporting](doc:data-reporting-overview) for more information on events and setting up event notifications. - [Cancel payment](https://developers.pismo.io/pismo-docs/reference/corporate-v2-post-cancel-payments.md): Cancel an existing payment operation. NOTE: - This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) Refer to [Data and reporting](doc:data-reporting-overview) for more information on events and setting up event notifications. - [Post multi-leg payment](https://developers.pismo.io/pismo-docs/reference/corporate-v3-post-multileg-payments-1.md): Allow you to submit a payment with multiple legs to the platform. The payments are processed asynchronously and must contain at least two legs, but no more than 20. The payload contains `debits` and `credits` lists. These lists include legs that follow the requirements of `credit` and `debit` objects in the [Post payment](ref:corporate-v2-post-payments) endpoint. For information about multi-leg payments, refer to the [Multi-leg payments](doc:multi-leg-payments) guide. **NOTES**: - To find the correct reason IDs, refer to the [List account status reasons](ref:get-accounts-v1-accounts-status-reasons) endpoint. - This endpoint does not support forced transfers from an earmark balance. - For error handling, see [Error handling mechanism](doc:payment-overview#error-handling-mechanism) in _Payment overview_. - **Processing sequence**: Debit legs are always processed before credit legs. Within each group, the sequence is not guaranteed, and the order of execution among debits or among credits is non-deterministic. Each leg generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - If flex controls are configured, a [Flex control evaluated](https://developers.pismo.io/events/docs/rules-evaluation-requested-1) event is triggered. Additionally, the following events are generated for multi-leg payments: - [Multi-leg payment lifecycle created](https://developers.pismo.io/events/docs/corporate-multi-leg-creation-2) - [Multi-leg payment lifecycle status changed](https://developers.pismo.io/events/docs/corporate-multi-leg-status-change-2) See [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. - [Get multi-leg payment status](https://developers.pismo.io/pismo-docs/reference/corporate-v3-get-multileg-payment.md): Enables users to query the processing status of a multi-leg payment. - [Schedule payment](https://developers.pismo.io/pismo-docs/reference/corporate-v2-post-scheduled-payments-1.md): Schedule payments for a specified future date (`schedule_datetime`). For more information, refer to [Schedule payment overview](https://developers.pismo.io/pismo-docs/docs/scheduled-payments). The payload for this request is similar to that of the [Post payment](ref:corporate-v2-post-payments) endpoint with the exception of the (`schedule_datetime`) property. See [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. For more information on payments operations, see [Corporate Banking Launch Reference](doc:corporate-banking-launch-reference). NOTE: - This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - For scheduled payments, validation of the transaction occurs only during the execution of the scheduled payment. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/availables-change-available-1) - [Current scheduled payment status displayed](https://developers.pismo.io/events/docs/corporate-schedule-payment-1) See [Data and reporting](doc:data-reporting-overview) for more information about events and how to set up event notifications. - [List scheduled payments](https://developers.pismo.io/pismo-docs/reference/corporate-v2-list-scheduled-payment.md): List all scheduled payments for an account. - [Get scheduled payment](https://developers.pismo.io/pismo-docs/reference/corporate-v2-get-scheduled-payment.md): Get a scheduled payment by its ID. - [Cancel scheduled payment](https://developers.pismo.io/pismo-docs/reference/corporate-v2-delete-scheduled-payment.md): Cancel a scheduled payment by its ID. For more information on payments operations, refer to the [Corporate Banking Launch Reference](doc:corporate-banking-launch-reference) guide. This endpoint generates a [Current scheduled payment status displayed](https://developers.pismo.io/events/docs/corporate-schedule-payment-1) event. See the [Data and reporting](doc:data-reporting-overview) guide for more information on events and setting up event notifications. **NOTE**: This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - [Past business date toggle](https://developers.pismo.io/pismo-docs/reference/put-back-business-toggle-1.md): This endpoint enables you to enable or disable the back business payment feature for a specific division, as well as `business_date` in the payments and multileg payments endpoint. For `business_date`, see [Post payment](ref:corporate-v2-post-payments) and [Post multileg payment](ref:corporate-v2-post-multileg-payments) for details. NOTE: - Only transactions for a business date are blocked. If you want to block transactions for more than one business date, you must call this endpoint to disable transactions for each business date. - It is not allowed to set a business date that falls within the current or a future business cycle. - The channel codes configured in this toggle act as an allowlist, so any payment submitted through one of those channels bypasses the back-business-dated restriction for the relevant division and business date. - For transfers, which involve both a debit account and a credit account, the toggle applies independently to each account’s administrative division. Both divisions must allow the back-business-dated operation; if either division rejects it, the system rejects the entire payment. This endpoint does not generate events. - [Post multi-leg payment (deprecated)](https://developers.pismo.io/pismo-docs/reference/corporate-v2-post-multileg-payments.md): Enable users to submit a payment with multiple legs to the platform. The payments are processed asynchronously and must contain at least two legs, but no more than twenty. The payload contains `debits` and `credits` lists. These lists include legs that follow the requirements of `credit` and `debit` objects in the [Post payment](https://developers.pismo.io/pismo-docs/reference/corporate-v2-post-payments) endpoint. For information about multi-leg payments, see the [Post multi-leg payment](https://developers.pismo.io/pismo-docs/docs/payment-overview#post-multi-leg-payment) section in _Payment overview_. NOTES: - To find the correct reason IDs, refer to the [List account status reasons](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-accounts-status-reasons) endpoint. - This endpoint does not support forced transfers from an earmark balance. - For error handling, see [Error handling mechanism](https://developers.pismo.io/pismo-docs/docs/payment-overview#error-handling-mechanism) in _Payment overview_. Each leg generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) - [Accounting entry created](https://developers.pismo.io/events/docs/accounting-entry-creation-1) - If flex controls are configured, a [Flex control evaluated](https://developers.pismo.io/events/docs/rules-evaluation-requested-1) event is triggered. Additionally, the following events are generated for multi-leg payments: - [Multi-leg payment lifecycle created](https://developers.pismo.io/events/docs/corporate-multi-leg-creation-1) - [Multi-leg payment lifecycle status changed](https://developers.pismo.io/events/docs/corporate-multi-leg-status-change-1) See [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. - [Get multi-leg payment status (deprecated)](https://developers.pismo.io/pismo-docs/reference/corporate-v2-get-multileg-payment.md): Enables users to query the processing status of a multi-leg payment. - [Get scheduled payment (Pismo account ID)](https://developers.pismo.io/pismo-docs/reference/cash-management-v2-get-scheduled-payment-1.md): Get a scheduled payment by its ID. - [Cancel payment (Pismo account ID)](https://developers.pismo.io/pismo-docs/reference/cash-management-v2-post-cancel-payments-1.md): Cancel an existing payment operation. NOTE: - This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) Refer to [Data and reporting](doc:data-reporting-overview) for more information on events and setting up event notifications. - [Confirm payment (Pismo account ID)](https://developers.pismo.io/pismo-docs/reference/cash-management-v2-post-confirm-payments-1.md): Confirm an existing payment operation. NOTE: - This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) See [Data and reporting](doc:data-reporting-overview) for more information on events and setting up event notifications. - [Post payment (Pismo account ID)](https://developers.pismo.io/pismo-docs/reference/cash-management-v2-post-payments-1.md): Enable users to submit a payment to the Pismo platform. It supports posting debits and credits to an account, as well as facilitating fund transfers between accounts. For details about payment operations, see [Payment overview](doc:payment-overview) and [Corporate Banking Launch Reference](doc:corporate-banking-launch-reference). NOTES: - This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - To get the correct reason IDs, refer to the [List account status reasons](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-accounts-status-reasons) endpoint.
Each payment operation created generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) - [Accounting entry created](https://developers.pismo.io/events/docs/accounting-entry-creation-1) - If flex controls are configured, a [Flex control evaluated](https://developers.pismo.io/events/docs/rules-evaluation-requested-1) event is triggered. See [Data and reporting](doc:data-reporting-overview) for more information on events and setting up event notifications. - [Schedule payment (Pismo account ID)](https://developers.pismo.io/pismo-docs/reference/cash-management-v2-post-scheduled-payments-1.md): Schedule payments for a specified future date (`schedule_datetime`). For more information, refer to [Schedule payment overview](https://developers.pismo.io/pismo-docs/docs/scheduled-payments). The payload for this request is similar to that of the [Post payment](ref:cash-management-v2-post-payments) endpoint with the exception of the (`schedule_datetime`) property. See [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. For more information on payments operations, see [Corporate Banking Launch Reference](doc:corporate-banking-launch-reference). NOTE: - This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - For scheduled payments, validation of the transaction occurs only during the execution of the scheduled payment. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/availables-change-available-1) - [Current scheduled payment status displayed](https://developers.pismo.io/events/docs/corporate-schedule-payment-1) See [Data and reporting](doc:data-reporting-overview) for more information about events and how to set up event notifications. - [Create earmark](https://developers.pismo.io/pismo-docs/reference/post-corporate-v2-earmarks.md): Create an earmark. An account holder can use an earmark to hold needed funds in reserve until a specified release date and time. Optionally, the account holder can schedule a payout for the release date and time. At that time, an automatic process releases the earmarked funds and settles the payout. It's possible to force the creation of an earmark by not performing any regular validations, such as account status, account balance, or flex controls validations. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) - [Transaction created](https://developers.pismo.io/events/docs/transaction-creation-1) - [Earmark created, updated, or canceled](https://developers.pismo.io/events/docs/corporate-earmark-1) with `CREATED` action. **NOTES**: - This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - [Update earmark](https://developers.pismo.io/pismo-docs/reference/patch-corporate-v2-earmarks-earmarkid.md): Update an earmark balance. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) - [Transaction created](https://developers.pismo.io/events/docs/transaction-creation-1) - [Earmark created, updated, or canceled](https://developers.pismo.io/events/docs/corporate-earmark-1) with `UPDATED` action. **NOTES**: - This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - To find the correct reason IDs, refer to the [List account status reasons](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-accounts-status-reasons) endpoint. - The maximum number of internal operation inputs (updates that change the earmark amount) allowed is 2,000. Update requests that exceed this limit return bad request errors. - An earmark balance cannot be reduced to zero as a result of this operation. If successfully executing the request would result in a zero balance, the request fails and a bad request error is returned. If you want to reduce the balance to zero, you must use [Cancel earmark](https://developers.pismo.io/pismo-docs/reference/post-corporate-v2-earmarks-earmarkid-cancel), instead. - [Cancel earmark](https://developers.pismo.io/pismo-docs/reference/post-corporate-v2-earmarks-earmarkid-cancel.md): Cancel a previously set earmark, releasing the earmarked funds, and preventing the earmark from executing at its scheduled expiration date/time. For more information about earmark operations, refer to the [Earmarks launch reference](doc:earmarks) guide. This endpoint generates the follow events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) - [Transaction created](https://developers.pismo.io/events/docs/transaction-creation-1) - [Earmark created, updated, or canceled](https://developers.pismo.io/events/docs/corporate-earmark-1) with `CANCELED` Action. See [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. **NOTE**: This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - [List earmarks](https://developers.pismo.io/pismo-docs/reference/get-corporate-earmarks.md): List all created earmarks, including ones that are canceled or have already been executed. - [Get earmark](https://developers.pismo.io/pismo-docs/reference/find-corporate-earmark.md): Get an earmark by its ID. - [Create earmark (Pismo account ID)](https://developers.pismo.io/pismo-docs/reference/post-cash-management-v2-earmarks.md): Create an earmark. An account holder can use an earmark to hold needed funds in reserve until a specified release date and time. Optionally, the account holder can schedule a payout for the release date and time. At that time, an automatic process releases the earmarked funds and settles the payout. It's possible to force the creation of an earmark by not performing any regular validations, such as account status, account balance, or flex controls validations. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) - [Transaction created](https://developers.pismo.io/events/docs/transaction-creation-1) - [Earmark created, updated, or canceled](https://developers.pismo.io/events/docs/corporate-earmark-1) with `CREATED` action. **NOTES**: - This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - [Update earmark (Pismo account ID)](https://developers.pismo.io/pismo-docs/reference/patch-cash-management-v2-earmarks-earmarkid.md): Update an earmark balance. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) - [Transaction created](https://developers.pismo.io/events/docs/transaction-creation-1) - [Earmark created, updated, or canceled](https://developers.pismo.io/events/docs/corporate-earmark-1) with `UPDATED` action. **NOTES**: - This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - To find the correct reason IDs, refer to the [List account status reasons](https://developers.pismo.io/pismo-docs/reference/get-accounts-v1-accounts-status-reasons) endpoint. - The maximum number of internal operation inputs (updates that change the earmark amount) allowed is 2,000. Update requests that exceed this limit return bad request errors. - An earmark balance cannot be reduced to zero as a result of this operation. If successfully executing the request would result in a zero balance, the request fails and a bad request error is returned. If you want to reduce the balance to zero, you must use [Cancel earmark](https://developers.pismo.io/pismo-docs/reference/post-cash-management-v2-earmarks-earmarkid-cancel), instead. - [Cancel earmark (Pismo account ID)](https://developers.pismo.io/pismo-docs/reference/post-cash-management-v2-earmarks-earmarkid-cancel.md): Cancel a previously set earmark, releasing the earmarked funds, and preventing the earmark from executing at its scheduled expiration date/time. For more information about earmark operations, refer to the [Earmarks launch reference](doc:earmarks) guide. This endpoint generates the follow events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance changed (Availables)](https://developers.pismo.io/events/docs/availables-change-available-1) - [Transaction created](https://developers.pismo.io/events/docs/transaction-creation-1) - [Earmark created, updated, or canceled](https://developers.pismo.io/events/docs/corporate-earmark-1) with `CANCELED` Action. See [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. **NOTE**: This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. - [List earmarks (Pismo account ID)](https://developers.pismo.io/pismo-docs/reference/get-cash-management-earmarks.md): List all created earmarks, including ones that are canceled or have already been executed. - [Get earmark (Pismo account ID)](https://developers.pismo.io/pismo-docs/reference/find-cash-management-earmark.md): Get an earmark by its ID. - [Create channel](https://developers.pismo.io/pismo-docs/reference/post-corporate-v1-channels.md): Creates a new channel for transaction routing and control.
A channel is a client‑defined code that identifies the source of a payment or cash‑management operation. It controls how back‑business‑date transactions are handled and determines whether a transaction can bypass cutoff rules, since only active channels in the allowed set can override the cutoff. Channels also enable routing based on the transaction’s source. This endpoint generates the following events: - [Channel created, updated, or deleted](https://developers.pismo.io/events/docs/cash-management-channel-1) Refer to [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. - [List channels](https://developers.pismo.io/pismo-docs/reference/get-corporate-v1-channels.md): Lists all active channels.
Returns only active (non-deleted) channels. Supports optional date range filtering and cursor-based pagination. - [Get channel](https://developers.pismo.io/pismo-docs/reference/get-corporate-v1-channels-channel.md): Gets a specific channel using channel code.
Returns the latest version of the channel, even if it has been soft‑deleted. The `deleted_at` field shows the channel’s lifecycle state: `null` indicates an active channel, while the timestamp indicates when it was deleted. - [Update channel](https://developers.pismo.io/pismo-docs/reference/patch-corporate-v1-channels-channel.md): Updates the description of an existing channel.
You can update `description`, but the channel code remains fixed. This endpoint generates the following events: - [Channel created, updated, or deleted](https://developers.pismo.io/events/docs/cash-management-channel-1) Refer to [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. - [Delete channel](https://developers.pismo.io/pismo-docs/reference/delete-corporate-v1-channels.md): Deletes an existing channel.
This operation prevents the channel from being used for new transactions. This endpoint generates the following events: - [Channel created, updated, or deleted](https://developers.pismo.io/events/docs/cash-management-channel-1) Refer to [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. - [Create check posting](https://developers.pismo.io/pismo-docs/reference/corporate-post-v1-checks.md): Allow clients to post a check for a specified external account, with the option to settle the amount either immediately or in the future. **NOTES**: * This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. * This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Check posting status change](https://developers.pismo.io/events/docs/cash-management-check-status-change-1) See [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. - [Get check posting](https://developers.pismo.io/pismo-docs/reference/corporate-get-v1-checks-id.md): Get information about a posted check using its check ID. - [Release check](https://developers.pismo.io/pismo-docs/reference/post-corporate-v1-checks-release.md): Releases a check using the provided payload. **NOTES**: - This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Check posting status change](https://developers.pismo.io/events/docs/cash-management-check-status-change-1) See [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. - [Cancel check](https://developers.pismo.io/pismo-docs/reference/post-corporate-v1-checks-checkid-cancel.md): Cancel a check using the provided check ID. **NOTES**: - This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Check posting status change](https://developers.pismo.io/events/docs/cash-management-check-status-change-1) See [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. - [List check settlement operations](https://developers.pismo.io/pismo-docs/reference/corporate-get-v1-check-settlement-operations.md): Retrieve a paginated list of settlement operations for a specific check. **NOTES**: - Requires an account token (access token encoded with a Pismo account ID). Tokens may expire quickly, resulting in a `401 Unauthorized` response. - [Create dormancy configuration](https://developers.pismo.io/pismo-docs/reference/post-dormancy-config-v2.md): Create a dormancy configuration at the division or program level. This configuration sets the days of inactivity required for accounts to switch to a dormant status and the reason for the switch. The dormancy configuration is applied to all accounts under the specified division or program. Automated dormancy checks are performed according to the number of days specified in the dormancy configuration. For information about dormancy, refer to [Dormancy overview](doc:dormancy-overview). This endpoint generates a [Dormancy configuration created](https://developers.pismo.io/events/docs/corporate-dormancy-config-creation-1) event. - [List dormancy configurations](https://developers.pismo.io/pismo-docs/reference/list-dormancy-configs.md): Lists all dormancy configurations for an organization. - [Get dormancy configuration](https://developers.pismo.io/pismo-docs/reference/getdormancyconfig.md): Retrieves a dormancy configuration by its ID. Also returns past configurations if you include a `showPrevious` query parameter set to 'true'. - [Update dormancy configuration](https://developers.pismo.io/pismo-docs/reference/patch-dormancy-config-v2.md): Updates a dormancy configuration for a division or program. This endpoint generates a [Dormancy configuration updated](https://developers.pismo.io/events/docs/corporate-dormancy-config-change-1) event. See [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications. - [Get account dormancy](https://developers.pismo.io/pismo-docs/reference/getaccountdormancy.md): Retrieves an account dormancy configuration by the account external ID. - [List transactions (transaction banking)](https://developers.pismo.io/pismo-docs/reference/get-corporate-transactions.md): Lists transactions of your transaction banking account. - [Get transaction (transaction banking)](https://developers.pismo.io/pismo-docs/reference/get-corporate-transaction.md): Gets transaction using transaction ID. - [List transaction status details (transaction banking)](https://developers.pismo.io/pismo-docs/reference/list-corporate-transaction-statuses.md): Returns a list of transactions mapped to a tracking ID. For each transaction, the request returns the approval status (approved or declined), as well as details such as amount, currency, and metadata. Multiple transactions can be associated with a single tracking ID; for example in transfers where both debit and credit legs are present. Additionally, if there are multiple attempts using the same tracking ID, all failed (declined) attempts are also included in the response. - [Upload public key](https://developers.pismo.io/pismo-docs/reference/post-bulk-keys.md): Upload a public key for validating signatures and sending signed bulk files. For detailed instructions on creating a public key, refer to the [Create public and private keys](doc:file-signature-and-encryption#creating-public-and-private-keys) section in File signature and encryption. - [Get public key](https://developers.pismo.io/pismo-docs/reference/get-bulk-keys.md): Get a public key by its ID. - [Create AES key (encrypted response)](https://developers.pismo.io/pismo-docs/reference/corporate-bulk-payments-put-aes-keys-jwe.md): Create an Advanced Encryption Standard (AES) key using bulk ID.
This endpoint uses JSON Web Encryption (JWE) to encrypt the response body at the message level. It takes a `public_key_id`, which refers to the public key you have already uploaded to the Pismo platform. Pismo uses this key to encrypt the response payload in accordance with the standard JWE protocol. To decrypt the response, you must use the corresponding private key. For information about file encryption and AES keys, refer to the [File encryption](doc:file-signature-and-encryption#file-encryption) section in File signature and encryption. The decrypted plaintext is a JSON object with fields: ```json { "aes_key": "245ca959580cae6317c8f8215cbae42c8b98bbf30d9f222b92db30df81a06f91" "iv": "7b75d3b5a25e9651e69245fa844cf3ec" } - [Upload bulk file](https://developers.pismo.io/pismo-docs/reference/corporate-put-bulk-file.md): This endpoint enables you to manage the upload of bulk files along with their corresponding signature data in the request header. Detailed flow: 1. The client sends a request with the bulk file as the body and signature in the `Signature` header. The signature header is formatted as `keyId="{key_id}",signature="{signature_base64}"`. The parameters `key_id` and `signature_base64` are specified in the `parameters` section. 2. The server processes the request and responds with a `200 OK` status, indicating the file upload request is complete. For detailed instructions, refer to [File signature and encryption](doc:file-signature-and-encryption). Note: Pismo reserves the right to offer this endpoint only for single-tenant clients, reach out to your Pismo representative for more information. - [Request bulk settlement](https://developers.pismo.io/pismo-docs/reference/post-bulk-settlement.md): This endpoint triggers the clearing of future value-dated payments and check-release operations in bulk.
A future value dated payment is a banking transaction that is scheduled to occur on a future date, such as a prepayment or normal payment. The bank is instructed to send the payment on a specific date, which can be the next day or later. When a payment is scheduled for a future date, the funds remain in the payer's account, continuing to accrue interest until the payment is settled on the scheduled date. A check release is the process that moves funds from an uncleared or held state into the customer’s available balance. After a check is deposited, some or all of its amount remains pending until a scheduled release. When the check is released, the pending funds are applied, and the account balances are updated so that the amount becomes fully available for use. NOTE: You can call this endpoint once with the same parameters, per division, settlement date, and operation type. If the process fails, you can retry up to 9 times per division, per business day. - [Create operation block](https://developers.pismo.io/pismo-docs/reference/corporate-post-v2-operation-blocks.md): **NOTE**: This v2 endpoint serves as a replacement for the v1 version. Creates an operation block for a division or program. This block prevents transactions from being executed within the specified division or program, unless certain operations are explicitly allowed to bypass the restriction. If neither `division_code` nor `program_id` is provided, the operation block is created for the whole organization. - [List operation blocks](https://developers.pismo.io/pismo-docs/reference/corporate-v2-list-operation-blocks.md): **NOTE**: This v2 endpoint serves as a replacement for the v1 version. Lists all operation blocks for an organization. - [Get operation block details](https://developers.pismo.io/pismo-docs/reference/corporate-get-v2-operation-blocks.md): **NOTE**: This v2 endpoint serves as a replacement for the v1 version. Gets details about an operation block. - [Update operation block](https://developers.pismo.io/pismo-docs/reference/corporate-patch-v2-operation-block-id.md): **NOTE**: This v2 endpoint serves as a replacement for the v1 version. Updates operation block properties.
You can use `allowed_operations` to allow certain financial transactions. - [Revoke operation block](https://developers.pismo.io/pismo-docs/reference/corporate-delete-v2-operation-block-id.md): **NOTE**: This v2 endpoint serves as a replacement for the v1 version. Cancels a previously configured operation block. - [Register banking accounts with transaction banking](https://developers.pismo.io/pismo-docs/reference/post-corporate-v2-register-account.md): Onboard accounts that already exist in Banking into Transaction Banking. Once onboarded, these accounts are enabled to use transaction banking APIs and features. - [Create fund restriction](https://developers.pismo.io/pismo-docs/reference/post-corporate-v1-restricted-funds.md): Create fund restriction. You can move funds from the `available_balance` to the `restricted_funds` balance. For details, refer to [Restrict funds](doc:restrict-funds). NOTE: - This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/availables-change-available-1) - [Restricted Funds created or released](https://developers.pismo.io/events/docs/corporate-restricted-funds-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) See [Data and reporting](doc:data-reporting-overview) for more information on events and setting up event notifications. - [List fund restrictions](https://developers.pismo.io/pismo-docs/reference/list-corporate-v1-restricted-funds.md): List all account fund restrictions. - [Get fund restriction](https://developers.pismo.io/pismo-docs/reference/get-corporate-v1-restricted-funds.md): Get details of a specific fund restriction by `restricted_funds_id`. - [Release restriction](https://developers.pismo.io/pismo-docs/reference/patch-corporate-v1-restricted-funds.md): Releases all or part of the funds from an existing restriction by restricted funds ID. NOTE: - This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message. This endpoint generates the following events: - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) - [Account balance changed](https://developers.pismo.io/events/docs/availables-change-available-1) - [Restricted Funds created or released](https://developers.pismo.io/events/docs/corporate-restricted-funds-1) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) See [Data and reporting](doc:data-reporting-overview) for more information on events and setting up event notifications. - [Register IBAN account](https://developers.pismo.io/pismo-docs/reference/post-intl-bank-accounts-v2-accounts-account-id-bank-accounts-iban.md): Register a new International Bank Account Number (IBAN) bank account. IBAN is a standardized international system developed to identify bank accounts when making international transactions. For more information, refer to What Is an International Bank Account Number (IBAN) and How Does It Work. To read about Pismo's banking offerings, see [Banking overview](doc:banking-overview). This endpoint generates a Bank account registered event. - [Register ACH account](https://developers.pismo.io/pismo-docs/reference/post-intl-bank-accounts-v2-accounts-account-id-bank-accounts-ach.md): Register a new Automated Clearing House (ACH) bank account. ACH is an electronic network for financial transactions in the United States. ACH processes large volumes of credit and debit transactions in batches. To read about Pismo's banking offerings, see [Banking overview](doc:banking-overview). This endpoint generates a [Bank account registered](https://developers.pismo.io/events/docs/intl-bankaccounts-intl-bankaccount-register-1) event. - [Register Fedwire account](https://developers.pismo.io/pismo-docs/reference/post-intl-bank-accounts-v2-accounts-account-id-bank-accounts-fedwire.md): Register a new Fedwire bank account. Fedwire is a real-time gross settlement funds transfer system operated by the Federal Reserve Banks in the United States. To read about Pismo's banking offerings, see [Banking overview](doc:banking-overview). This endpoint generates a [Bank account registered](https://developers.pismo.io/events/docs/intl-bankaccounts-intl-bankaccount-register-1) event. - [Register CLABE account](https://developers.pismo.io/pismo-docs/reference/post-intl-bank-accounts-v2-accounts-account-id-bank-accounts-clabe.md): Register a new Clave Bancaria Estandarizada (CLABE) bank code for Mexican bank accounts. A Clave Bancaria Estandarizada, commonly known as CLABE, is an 18-digit standardized banking code used in Mexico for domestic electronic fund transfers. It functions as a unique identifier for each bank account, similar to an International Bank Account Number (IBAN) in other countries. The CLABE is required for sending and receiving inter-bank transfers within Mexico. To read about Pismo's banking offerings, see [Banking overview](doc:banking-overview). This endpoint generates a Bank account registered event. - [Register UK bank account](https://developers.pismo.io/pismo-docs/reference/post-intl-bank-accounts-v2-accounts-account-id-bank-accounts-uk-scan.md): Register a new bank account with UK's sort code + account number (SCAN) scheme. In UK banking, a sort code is a unique identifier used to route money transfers between banks and financial institutions. Its similar to a routing number in the US. It is a six-digit number that identifies both the bank and the specific branch. Each bank and branch has its own unique sort code. The first two digits identify the bank and the remaining 4 digits identify the branch. To read about Pismo's banking offerings, see [Banking overview](doc:banking-overview). This endpoint generates a Bank account registered event. - [Register Brazilian bank account](https://developers.pismo.io/pismo-docs/reference/post-intl-bank-accounts-v2-accounts-account-id-bank-accounts-brazil.md): Register a new bank account with Brazilian bank + branch + account number scheme. To read about Pismo's banking offerings, see [Banking overview](doc:banking-overview). This endpoint generates a Bank account registered event. - [Register BBAN account](https://developers.pismo.io/pismo-docs/reference/post-intl-bank-accounts-v2-accounts-account-id-bank-accounts-bban.md): Register a new Basic Bank Account Number (BBAN) bank account. BBAN is a bank account numbering system used in many countries, especially in Europe. For international transactions, the BBAN is combined with the country code and a checksum to create an IBAN (International Bank Account Number). To read about Pismo's banking offerings, see [Banking overview](doc:banking-overview). This endpoint generates a Bank account registered event. - [Get bank account](https://developers.pismo.io/pismo-docs/reference/get-intl-bank-accounts-v2-bank-accounts-account-id-bank-accounts-scheme-name.md): Get a bank account given its Pismo account ID and scheme name in the path. To read about Pismo's banking offerings, see [Banking overview](doc:banking-overview). - [Delete bank account](https://developers.pismo.io/pismo-docs/reference/delete-intl-bank-accounts-v2-accounts-account-id-bank-accounts-scheme-name.md): Delete a bank account given its Pismo account ID and scheme name in the path. To read about Pismo's banking offerings, see [Banking overview](doc:banking-overview). This endpoint generates a Bank account updated event. - [Update bank account](https://developers.pismo.io/pismo-docs/reference/update-intl-bank-accounts-v2-accounts-account-id-bank-accounts-scheme-name.md): Update a bank account given its Pismo account ID and scheme name in the path. To read about Pismo's banking offerings, see [Banking overview](doc:banking-overview). This endpoint generates a Bank account updated event. - [Get UK bank branch info](https://developers.pismo.io/pismo-docs/reference/get-intl-bank-accounts-v1-sort-codes-sort-code.md): Get information for a United Kingdom (UK) bank-branch given its *sort code* in the path. To read about Pismo's banking offerings, see [Banking overview](doc:banking-overview). In UK banking, a sort code is a unique identification code used to route money transfers between banks and financial institutions. Its similar to a routing number in the US. It is a six-digit number that identifies both the bank and the specific branch. Each bank and branch has its own unique sort code. The first two digits identity the bank and the remaining 4 digits identify the branch. - [Search bank account](https://developers.pismo.io/pismo-docs/reference/post-intl-bank-accounts-v3-bank-accounts-scheme-name-search.md): Search for a bank account using various account schemes. - [Register beneficiary](https://developers.pismo.io/pismo-docs/reference/post-intl-bank-accounts-v1-bank-accounts-beneficiaries.md): Register a new beneficiary with Pismo. A newly-registerd beneficiary is not initially enabled and must be activated before use in transactions. - [List beneficiaries](https://developers.pismo.io/pismo-docs/reference/get-intl-bank-accounts-v1-bank-accounts-beneficiaries.md): List registered beneficiaries with query filtering options. - [Activate beneficiary](https://developers.pismo.io/pismo-docs/reference/post-intl-bank-accounts-v1-bank-accounts-beneficiaries-beneficiary-id-activate.md): Activate a beneficiary. Activating a beneficiary authorizes or confirms a particular individual, organization, or account can receive frunds from another account. This is usually required before initiating transactions, especially fund transfers, to ensure that the recipient is approved to receive money. - [Get beneficiary](https://developers.pismo.io/pismo-docs/reference/get-intl-bank-accounts-v1-bank-accounts-beneficiaries-beneficiary-id.md): Get a beneficiary's information given its ID in the path. - [Update beneficiary](https://developers.pismo.io/pismo-docs/reference/patch-intl-bank-accounts-v1-beneficiaries-beneficiary-id.md): Update a beneficiary given its ID in the path. - [Delete beneficiary](https://developers.pismo.io/pismo-docs/reference/delete-intl-bank-accounts-v1-beneficiaries-beneficiary-id.md): Delete a beneficiary given its ID in the path. - [Register banking asset](https://developers.pismo.io/pismo-docs/reference/assetregistration.md): Register a banking asset with the Pismo platform. A banking asset is either a certificate of deposit or a bank receipt. This endpoint generates an [Asset registration succeeded](https://developers.pismo.io/events/docs/assets-asset-registration-success-1) event if it succeeds or an [Asset registration failed](https://developers.pismo.io/events/docs/assets-asset-registration-failure-1) event if it doesn't. - [Get banking asset](https://developers.pismo.io/pismo-docs/reference/assetbyid.md): Get banking asset using issuer and asset IDs - [Update banking asset](https://developers.pismo.io/pismo-docs/reference/updateasset.md): Update a banking asset using issuer and asset IDs This endpoint generates an [Asset updated](https://developers.pismo.io/events/docs/assets-asset-update-1) event. - [Delete banking asset](https://developers.pismo.io/pismo-docs/reference/assetcancellation.md): Delete a banking asset previously registered with the Pismo platform This endpoint generates an [Asset status changed](https://developers.pismo.io/events/docs/assets-asset-status-change-1) event. - [Create banking asset redemption](https://developers.pismo.io/pismo-docs/reference/assetredemptionv2.md): Create a banking asset redemption. A banking asset redemption is the repayment of the original value of the asset to the investor. If the request succeeds, this endpoint generates an [Asset redeemed](https://developers.pismo.io/events/docs/assets-asset-redemption-1) event and an [Asset status changed](https://developers.pismo.io/events/docs/assets-asset-status-change-1) event. If it fails, it generates an [Asset redemption failed](https://developers.pismo.io/events/docs/assets-asset-redemption-failure-1) event. - [List banking asset redemptions](https://developers.pismo.io/pismo-docs/reference/assetredemption.md): List banking asset redemptions using asset and issuer IDs - [Get banking asset balance](https://developers.pismo.io/pismo-docs/reference/assetbalance.md): Get banking asset balance using asset ID - [Block/unblock banking asset](https://developers.pismo.io/pismo-docs/reference/assetblock.md): Block or unblock a banking asset If the request succeeds, this endpoint generates an [Asset blocked](https://developers.pismo.io/events/docs/assets-asset-block-1) event; otherwise, generates an [Asset block failed](https://developers.pismo.io/events/docs/assets-asset-block-failure-1) event. - [Migrate banking asset](https://developers.pismo.io/pismo-docs/reference/postassetblock.md): Migrate banking asset If the request succeeds, this endpoint generates an asset_block-1 event. If it fails, it generates an asset_block_failure-1 event. - [Update quota](https://developers.pismo.io/pismo-docs/reference/updatequota.md): Updates a quota by its ID. A quota is the number of asset shares. One asset can consist of a single share or multiple shares. You can get quota IDs with the List asset quotas endpoint. This endpoint generates a [Quota updated](https://developers.pismo.io/events/docs/assets-quota-update-1) event. - [List asset quotas](https://developers.pismo.io/pismo-docs/reference/assetquotas.md): Retrieves asset quotas by asset ID. A quota is the number of asset shares. One asset can consist of a single share or multiple shares. - [Register for TED transfers](https://developers.pismo.io/pismo-docs/reference/post-save-provider-configuration.md): Register a client's configuration at a provider who is authorized to use the Brazil Central Bank's (BCB) payment system (SPB) for TED transfers. TED stands for Transferência Eletrônica Disponível (Electronic transfer available) and is a Brazilian electronic funds transfer system that allows businesses and individuals to transfer funds between different banks. Pismo uses this configuration to authorize TED transfers on clients' behalf. - [Register receivable](https://developers.pismo.io/pismo-docs/reference/create-receivable.md): Register an account receivable - Brazil only. A receivable represents money expected to be collected from an entity (*debtor*) who has purchased products or services, but has not yet paid for them in full. The *lender*, the person or entity owed the money, can sell this debt to a new *owner*, who may package it as part of another financial instrument, in much the same way a mortgage is sold to become part of a mortgage-backed security. Pismo works with B3 - a large financial market infrastructure provider in Brazil - to register invoices. If creation fails, a credit_rights_registration_failure-1 event is generated. If creation succeeds, a credit_rights_registration_success-1 event is generated - [Get receivable (deprecated)](https://developers.pismo.io/pismo-docs/reference/get-receivable.md): Get unique receivable. This endpoint is **DEPRECATED**, use the Validate receivable endpoint instead. - [Get credit rights](https://developers.pismo.io/pismo-docs/reference/findbyinternalnumber.md): Get credit rights with internal number. - [Update receivable](https://developers.pismo.io/pismo-docs/reference/update.md): Update receivable for fields passed. If updating the status fails, a credit_rights_status_change_failure-1 event is generated. If updating the status succeeds, a credit_rights_status_change_success-1 event is generated. If updating any other fields besides status fails, a credit_rights_change_failure-1 event is generated. If updating a non-status field succeeds, a credit_rights_change_success-1 event is generated. - [Delete receivable](https://developers.pismo.io/pismo-docs/reference/delete-receivable.md): Delete receivable. If deletion fails, a credit_rights_status_change_failure-1 event is generated. If deletion succeeds, a credit_rights_status_change_success-1 event is generated. - [Validate receivable](https://developers.pismo.io/pismo-docs/reference/validateunicity.md): Validate a receivable's uniqueness in the credit rights registry. - [Get invoice](https://developers.pismo.io/pismo-docs/reference/findbyaccesskey.md): Get and validate invoice given access key in path. The access key is created via the [Register receivable](create-receivable) endpoint. Pismo works with a third-party (B3) who registers the invoices. This endpoint generates 4 possible events: 1. Request to third-party fails - invoice_validation_request_failure-1 2. Request to third-party succeeds - invoice_validation_request_success-1 3. Third-party validation fails- invoice_validation_failure-1 4. Third-party validation succeeds - invoice_validation_success-1 - [Create protection source](https://developers.pismo.io/pismo-docs/reference/post-protection-source.md): Create new funds coverage protection source to cover insufficient funds.
The funds coverage service enables financial products—such as savings accounts, loans, and credit cards—to serve as coverage sources for other products when there is an insufficient balance or a payment failure. It supports overdraft coverage type, configurable fallback hierarchies, and is designed for future extensibility to accommodate additional product types. Refer to the [Funds coverage](doc:funds-coverage) guide for more details. - [Update protection source](https://developers.pismo.io/pismo-docs/reference/update-protection-source.md): Update protection source. If a source does not exist, the Pismo platform selects one from `sources.type`. - [Get protection source](https://developers.pismo.io/pismo-docs/reference/get-protection-source.md): Get funds coverage protection source using your account ID - [Issue bank slip](https://developers.pismo.io/pismo-docs/reference/post-integrated-payments-api-v1-bankslips-issue.md): Create a bank slip and issue it to the provider. See [Bank slips](doc:bank-slips) for more information.
This endpoint generates the [Bank slip issuance registered](https://developers.pismo.io/events/docs/integrated-payments-bankslip-issue-register-1) event. - [List issued bank slips](https://developers.pismo.io/pismo-docs/reference/get-integrated-payments-api-v1-bankslips-issue.md): Retrieve a list of issued bank slips. - [Get issued bank slip](https://developers.pismo.io/pismo-docs/reference/get-integrated-payments-api-v1-bankslips-issue-retrieve.md): Retrieve a previously issued bank slip from the provider. This endpoint only returns one bank slip at a time. - [Delete issued bank slip](https://developers.pismo.io/pismo-docs/reference/delete-integrated-payments-api-v1-bankslips-issue.md): Delete a previously issued bank slip and cancel it for the provider.
This endpoint produces the [Bank slip issuance canceled](https://developers.pismo.io/events/docs/integrated-payments-bankslip-issue-cancel-1) event. - [Pay bank slip](https://developers.pismo.io/pismo-docs/reference/post-integrated-payments-api-v1-bankslips-pay.md): In Brazil, bank slips, known as *Boleto Bancarios* or simply *Boletos* in Portuguese, are a popular payment method for various services, bills, and purchases. When a payment needs to be made, the recipient (such as a business or service provider) generates a Boleto with the necessary payment details, such as the recipent's information, the payment amount, due date, barcode, and other relevant information. Pismo works with [BTG Pactual](https://www.btgpactual.us), [Celcoin](https://celcoin.com.br), and [Itaú](https://www.itau.com.br) to implement Boleto payments. In the future, Pismo may work with additional financial companies. This endpoint generates the following events: * [Authorization created](https://developers.pismo.io/events/docs/authorization-authorization-event-1) - This event contains bank slip information (beneficiary name and document number, digitable line, amount, payment date, interest/fine and discount (if any) in the `metadata` field. * [Financial bank slip status changed](https://developers.pismo.io/events/docs/integrated-payments-bankslip-status-change-1) - Before clearing, a bank slip's status is `PAID`. After clearing, Pismo changes its status to `SETTLED`. * [Integrated payments financial reconciliation](https://developers.pismo.io/events/docs/integrated-payments-financial-reconciliation-1)- This event is generated after the transaction has been cleared and accounts debited or credited. If `x-skip-reconciliation` is `true` or the provider is JD Consultores, this event is not generated.
See [Bank slips](doc:bank-slips) for more information.
**Important**: You need to call [Validate bank slip](ref:post-integrated-payments-api-v1-bankslips-validate) before calling this endpoint and pass the `external_authorization` field value if it is returned from that call here. - [Validate bank slip](https://developers.pismo.io/pismo-docs/reference/post-integrated-payments-api-v1-bankslips-validate.md): Validate bank slip with provider partner.
You need to call this endpoint before calling [Pay bank slip](ref:post-integrated-payments-api-v1-bankslips-pay). If this endpoint returns an `external_authorization` field value, you must pass it in the Pay bank slip call.
For this endpoint, either `bar_code` or `digitable_line` **must** be passed. - [List bank slip receipt](https://developers.pismo.io/pismo-docs/reference/get-integrated-payments-api-v1-bankslips-receipts.md): Retrieve bank slip payment receipts with filtering options. - [Perform cash-out](https://developers.pismo.io/pismo-docs/reference/post-integrated-payments-api-v1-bankslips-cashout.md): Perform an external transfer, using a provider to process the outgoing account resources. This endpoint generates the following events: * [Transfer-out created](https://developers.pismo.io/events/docs/integrated-payments-transfer-out-created-1) - Cash-out event. * [Financial transaction status updated](https://developers.pismo.io/events/docs/integrated-payments-transaction-status-change-1) - Cash out status change. Status becomes `SETTLED` after clearing and accounts have been credited and debited. * [Integrated payments financial reconciliation](https://developers.pismo.io/events/docs/integrated-payments-financial-reconciliation-1)- This event is generated after the transaction has been cleared and accounts debited or credited. - [List transfer](https://developers.pismo.io/pismo-docs/reference/get-integrated-payments-api-v1-transfers.md): Retrieve transfers list. - [Register eBill](https://developers.pismo.io/pismo-docs/reference/post-integrated-payments-api-v1-ebill-registration-accounts-accountid.md): Register eBill for an account.
eBill offers an electronic view of bank slips linked to your document number, simplifying daily use without paper documents. You can pay slips via internet banking or a banking app, minimizing barcode errors, and track all accounts under your document number. For more details, refer to the [eBill](doc:banking-overview#ebill) section in the *Banking overview* guide.
This endpoint generates an [eBill registration status updated](https://developers.pismo.io/events/docs/integrated-payments-ebill-status-change-1) event. - [Get eBill registration](https://developers.pismo.io/pismo-docs/reference/get-integrated-payments-api-v1-ebill-registration-accounts-accountid.md): Retrieve eBill registration information. - [Delete eBill registration](https://developers.pismo.io/pismo-docs/reference/delete-integrated-payments-api-v1-ebill-registration-accounts-accountid.md): Delete eBill registration.
This endpoint produces an [eBill registration status updated](https://developers.pismo.io/events/docs/integrated-payments-ebill-status-change-1) event. - [Create provider credential](https://developers.pismo.io/pismo-docs/reference/post-credentials.md): Create or update your credentials with a third-party banking partner (provider). Banking as a Service clients need to partner with a provider such as Celcoin, BTG, or JD Consultores. When you call this endpoint with your authentication key and secret, Pismo saves and encrypts the information you provide, then uses it to obtain an access token from the provider. For more information, see [Banking as a Service overview](doc:banking-as-a-service) - [Create balance](https://developers.pismo.io/pismo-docs/reference/post-v1-interest-balance.md): Register a balance for an interest-bearing account using a previously configured interest plan to determine applicable interest rates. This endpoint generates the Interest balance succeeded event when the balance is created successfully. The event payload includes: `program_id`, `balance_id`, `account_id`, `interest_plan_id`, `balance`, `start_cycle_date`, `value_date`, and `maturity_date`. Optional fields `division_id` and `external_account_id` are included in the event only when present in the request. - [Deposit money](https://developers.pismo.io/pismo-docs/reference/post-v1-interest-deposit.md): Deposit amount into the specified account using a previously configured interest plan to calculate applicable interest rates. This endpoint generates the following events. - [Interest deposit succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-deposit-success-1) when deposit operation succeeds - [Interest deposit failed](https://developers.pismo.io/events/docs/interest-engine-interest-deposit-failure-1) when deposit operation fails The following events are applicable only to Brazil and are generated instead of the two events above when this endpoint is requested by a B3 (Brasil, Bolsa, Balcão) organization. - [Interest registration succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-registration-success-1) when deposit operation succeeds - [Interest registration failed](https://developers.pismo.io/events/docs/interest-engine-interest-registration-failure-1) when deposit operation fails For more information, refer to the [Interest-bearing accounts](doc:interest-bearing-accounts) guide. - [Withdraw money](https://developers.pismo.io/pismo-docs/reference/post-v1-interest-withdrawal.md): Withdraw amount from an account. This endpoint generates the following events. - [Interest withdrawal succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-withdrawal-success-1) when withdrawal operation succeeds - [Interest withdrawal failed](https://developers.pismo.io/events/docs/interest-engine-interest-withdrawal-failure-1) when withdrawal operation fails For more information, refer to the [Interest-bearing accounts](doc:interest-bearing-accounts) guide. - [Cancel account](https://developers.pismo.io/pismo-docs/reference/post-v1-interest-account-cancellation.md): Cancel all operations for the specified account, and withdraw the remaining balance. This endpoint generates the following events. - [Interest account cancellation succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-account-cancellation-success-1) when account cancellation operation succeeds - [Interest account cancellation failed](https://developers.pismo.io/events/docs/interest-engine-interest-account-cancellation-failure-1) when account cancellation fails For more information, refer to the [Interest-bearing accounts](doc:interest-bearing-accounts) guide. - [Calculate average balance](https://developers.pismo.io/pismo-docs/reference/interest-bearing-calculate-average-balance.md): Calculate an average balance for an account.
Using this endpoint, you specify a datetime range and calculate the [average balance](https://www.investopedia.com/terms/a/average-balance.asp) of an account for that period. The calculation multiplies each unchanged balance by the number of days it remains constant, sums those values, and divides the total by the number of days in the selected range.
This endpoint generates the [Average balance calculated](https://developers.pismo.io/events/docs/average-balance-calculated-average-balance-1) event once calculation is complete. - [Get average balance](https://developers.pismo.io/pismo-docs/reference/interest-bearing-get-average-balance.md): Get an already calculated average balance for an account. - [Get account attachment](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-get-account-attachment.md): Get an account's attached product. - [Attach deposit to account](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-deposit-attach-account.md): Attach a time deposit product to an account. This endpoint generates the [Account attached](https://developers.pismo.io/events/docs/deposit-product-account-attach-1) event. - [Detach deposit from account](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-deposit-detach-account.md): Detach a time deposit product from an account. This endpoint generates the [Account detached](https://developers.pismo.io/events/docs/deposit-product-account-detach-1) event. - [Update payout account for deposit account](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-deposit-update-payout-account.md): Update the payout account configuration for an attached deposit account. The payout account specifies where interest payments and maturity proceeds are sent. - [Attach savings account to account](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-savings-account-attach-account.md): Attach a savings account product to an account. This endpoint generates the [Account attached](https://developers.pismo.io/events/docs/deposit-product-account-attach-1) event. - [Detach savings account from account](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-savings-account-detach-account.md): Detach a savings account product from an account. This endpoint generates the [Account detached](https://developers.pismo.io/events/docs/deposit-product-account-detach-1) event. - [Update payout account for savings account](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-savings-account-update-payout-account.md): Update the payout account configuration for an attached savings account. The payout account specifies where interest payments are sent. - [Update deposit account attachment overrides](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-deposit-update-account-attachment.md): Partially updates `deposit_configs.overrides` and `deposit_configs.interest_capitalization_mode` on an active deposit account attachment. Each field is processed using three‑state `PATCH` semantics, allowing values to be added, changed, or cleared as part of the update. * **Omitted**: Keeps the current value * `null`: Removes the override; falls back through the cascade (program → product) * **Value**: Replaces the current override with the supplied value **NOTES**: * At least one of `deposit_configs.overrides` or `deposit_configs.interest_capitalization_mode` must be provided. * The `overrides` envelope, if provided, must contain at least one field. Sending an empty object returns `400 EIBACC0315`. * `renewal_term` still requires `ROLLOVER` configured in `maturity_instructions` somewhere in the fallback sequence (`400 EIBACC0310` otherwise). This endpoint generates an [Account attachment updated](https://developers.pismo.io/events/docs/deposit-product-account-attachment-updated-1) event. - [Get cycle snapshot for deposit account](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-get-cycle-snapshot.md): Return a consolidated point‑in‑time snapshot of a deposit account lifecycle, providing current and previous cycle details such as active and prior product attachments, key dates (cycle start, maturity, rollover), interest plan information, and principal context to support audit, statement, and reconciliation use cases. - [Simulate penalty](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-simulate-penalty.md): Simulate the penalty applied to a specified withdrawal on a given date. The operation is read‑only and does not modify any data. Use this endpoint to preview penalty fees before making an actual withdrawal. The simulation evaluates all penalty rules configured in the product, including: - Early withdrawal penalties - Grace period penalties - Tiered interest forfeiture penalties - Withdrawal fees - Subsequent withdrawal penalties Notes: - A withdrawal date inside the cool‑off period results in no penalties - If `withdrawal_amount` is omitted, the Pismo platform fetches the current book balance from [Get transaction banking account balance](ref:get-account-balances). - If `withdrawal_amount` is provided, the balance cannot exceed the current book balance. - [List products](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-list-products.md): Return a list of an organization's savings and time-deposit accounts. - [Create deposit product](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-create-deposit-product.md): Create an organization's time deposit accounts. Time deposit accounts, such as CDs, require you to keep your funds in the account for a mutually agreed amount for a specific period of time.
This endpoint generates the [Deposit product created](https://developers.pismo.io/events/docs/deposit-product-creation-1) event. For information about interest-bearing accounts, refer to [Interest-bearing accounts](doc:interest-bearing-accounts). - [Get deposit product](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-get-deposit-products.md): Get deposit product by product ID. Note that product ID is Pismo-generated. - [Update deposit product](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-patch-deposit-product.md): Update deposit by product ID. Note that product ID is Pismo-generated.
This endpoint generates the [Deposit product updated](https://developers.pismo.io/events/docs/deposit-product-update-1) event. - [Create savings account product](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-create-savings-account-product.md): Create an organization's savings account product. Savings account products accrue interest based on the balance at the time of the interest calculation.
This endpoint generates the [Savings account product created](https://developers.pismo.io/events/docs/savings-account-product-creation-1) event. For information about interest-bearing accounts, see [Interest-bearing accounts](doc:interest-bearing-accounts). - [Get savings account product](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-get-savings-account-products.md): Get saving accounts product by product ID. Note that product ID is Pismo-generated. - [Update savings account product](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-patch-savings-account-product.md): Update a savings account product by product ID. Note that product ID is Pismo-generated.
This endpoint generates the [Savings account product updated](https://developers.pismo.io/events/docs/savings-account-product-update-1) event. - [Open deposit account](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-deposit-account-open.md): Creates or locates a transaction banking account and attaches a validated deposit product in a single request. When the operation succeeds, the Pismo platform generates the [Deposit account opened](https://developers.pismo.io/events/docs/deposit-product-deposit-account-opened-1) and [Account attached](https://developers.pismo.io/events/docs/deposit-product-account-attach-1) events. This endpoint supports two scenarios: * **Existing account**: Provide both `account.account_id` and `account.external_account_id`. The Pismo platform locates the account via the transaction banking API and validates the IDs. If there is a mismatch, the request fails with a `400` error. * **New account**: Provide `account.external_account_id` and the `account_creation` object. The Pismo platform creates a new transaction banking account and attaches the deposit product. If the transaction banking API returns `409` because the account already exists, the Pismo platform locates the existing account and proceeds with product attachment. **Note**: The deposit product must exist, be of type `deposit`, and have an `ACTIVE` status. - [Get program attachment](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-get-program-attachment.md): Get a program's attached product. - [Attach deposit product to program](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-deposit-attach-program.md): Attach a time deposit product to a program. This endpoint generates the [Program attached](https://developers.pismo.io/events/docs/deposit-product-program-attach-1) event. At the program scope, `deposit_configs.overrides` only accepts `renewal_term`. Sending `penalties` returns `400 EIBACC0317` and sending `maturity_instructions` returns `400 EIBACC0318` — apply those per-account instead. - [Attach savings accounts to program](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-savings-account-attach-program.md): Attach a savings accounts product to a program. This endpoint generates the [Program attached](https://developers.pismo.io/events/docs/deposit-product-program-attach-1) event. - [Update deposit program attachment overrides](https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-deposit-update-program-attachment.md): Partially updates `deposit_configs.overrides` and `deposit_configs.interest_capitalization_mode` on an active deposit program attachment. Each field follows three‑state `PATCH` rules, allowing values to be set, changed, or cleared. At the program level, the only supported override inside `overrides` is `renewal_term`. * **Omitted**: Keeps the current value * `null`: Removes the override; falls back through the cascade (product) * **Value**: Replaces the current value **NOTES**: * At least one of `deposit_configs.overrides` or `deposit_configs.interest_capitalization_mode` must be provided. * Sending `penalties` inside `overrides` returns `400 EIBACC0317` * Sending `maturity_instructions` inside `overrides` results in a `400 EIBACC0318` error. This field cannot be modified at the program level and must be configured on each account attachment instead. * An empty `overrides` envelope returns `400 EIBACC0315` * `renewal_term` still requires `ROLLOVER` configured in `maturity_instructions` somewhere in the fallback sequence (`400 EIBACC0310` otherwise) This endpoint generates a [Program attachment updated](https://developers.pismo.io/events/docs/deposit-product-program-attachment-updated-1) event. - [Create interest plan (B3 only)](https://developers.pismo.io/pismo-docs/reference/post-v1-interest-plan-b3.md): Create an interest plan configuration that defines how the platform calculates interest accrual. **Note:** Only Brazilian Stock Exchange (B3) customers should use this endpoint. Once created, you can apply the interest plan to a specific product or account. For example, you can provide the `interest_plan_id` when creating a [deposit product](ref:interest-bearing-v1-create-deposit-product), when creating a [savings account](ref:interest-bearing-v1-create-savings-account-product), or when [depositing money](ref:post-v1-interest-deposit) into an account. This endpoint generates an [Interest plan creation succeeded](https://developers.pismo.io/events/docs/interest-management-interest-plan-creation-success-1) event. For more information, refer to the [Interest-bearing accounts](doc:interest-bearing-accounts) guide. - [Get interest plan (B3 only)](https://developers.pismo.io/pismo-docs/reference/get-v1-interest-plan-b3.md): Get interest plan details. **Note:** Only Brazilian Stock Exchange (B3) customers should use this endpoint. - [Get account interest (B3 only)](https://developers.pismo.io/pismo-docs/reference/get-v1-interest-account-b3.md): Get account interest details. **Note:** Only Brazilian Stock Exchange (B3) customers should use this endpoint. - [Update account interest (B3 only)](https://developers.pismo.io/pismo-docs/reference/put-v1-interest-account-b3.md): Apply specific interest accrual options to an account. **Note:** Only Brazilian Stock Exchange (B3) customers should use this endpoint. - [Configure benchmark rate (B3 only)](https://developers.pismo.io/pismo-docs/reference/post-v1-benchmark-rate-b3.md): Configure the benchmark rate and its start date. Used to calculate interest accual for floating and hybrid investments. **Note:** Only Brazilian Stock Exchange (B3) customers should use this endpoint. - [Get Org benchmark rates (B3 only)](https://developers.pismo.io/pismo-docs/reference/get-v1-benchmark-rate-org-b3.md): Get all benchmark rates configured for an organization. **Note:** Only Brazilian Stock Exchange (B3) customers should use this endpoint. - [Get specific benchmark rates (B3 only)](https://developers.pismo.io/pismo-docs/reference/get-v1-benchmark-rate-b3.md): Get all rates configured for a specific benchmark. **Note:** Only Brazilian Stock Exchange (B3) customers should use this endpoint. - [Get account interest](https://developers.pismo.io/pismo-docs/reference/get-v1-interest-account.md): Get account interest details. - [Update account interest](https://developers.pismo.io/pismo-docs/reference/put-v1-interest-account.md): Apply specific interest accrual options to an account by replacing its full interest configuration. This operation has full-replacement semantics: every request must redeclare the complete configuration. Partial updates (sending only the fields you want to change) are not supported and cause the validation to fail. Although every property in the request body is independently optional, the body as a whole must satisfy several conditional rules. See the request body schema description for the full set of `benchmark`/`fixed_interest_rate`, `tax_withholding`, and `taxes_exemption` rules. - [Configure benchmark rate](https://developers.pismo.io/pismo-docs/reference/post-v1-benchmark-rate.md): Configure the benchmark rate and its start date. Used to calculate interest accual for floating and hybrid investments. - [Get Org benchmark rates](https://developers.pismo.io/pismo-docs/reference/get-v1-benchmark-rate-org.md): Get all benchmark rates configured for an organization. - [Get rates for a specific benchmark](https://developers.pismo.io/pismo-docs/reference/get-v1-benchmark-rate.md): Get all rates configured for a specific benchmark. - [Configure timing for accrual calculation](https://developers.pismo.io/pismo-docs/reference/post-v1-interest-accrual-setup.md): Set up the time when the daily accrual calculations should occur. If you provide a value for `division_id`, then the value provided in `time_utc` is only used for the corresponding division. That is, it's only used for the accruals of installment plans associated with that division. If you don't provide a value for `division_id`, then the value provided in `time_utc` is used for all installment plans in the program's org, unless they are associated with a division that already has a time assigned to it. (That is, unless you already ran the endpoint with `division_id` set to the ID for that division.) Note: If you run the endpoint a second time using the same value `division_id`, it generates an error. This also happens if you run the endpoint twice without providing a value for `division_id`. - [Create interest plan](https://developers.pismo.io/pismo-docs/reference/post-v1-interest-plan.md): Create an interest plan configuration that defines how the platform calculates interest accrual. After it's created, you can apply the interest plan to a specific product or account. For example, you can provide the `interest_plan_id` when creating a [deposit product](ref:interest-bearing-v1-create-deposit-product), when creating a [savings account](ref:interest-bearing-v1-create-savings-account-product), or when [depositing money](ref:post-v1-interest-deposit) into an account. This endpoint generates an [Interest plan creation succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-plan-creation-success-1) event. For more information, refer to the [Interest-bearing accounts](doc:interest-bearing-accounts) guide. - [List Org interest plans](https://developers.pismo.io/pismo-docs/reference/get-v1-interest-plans.md): List all interest plans for a given Org. - [Get interest plan](https://developers.pismo.io/pismo-docs/reference/get-v1-interest-plan.md): Get interest plan details. By default, returns the latest version of the interest plan. You can optionally specify a `version_date` query parameter to retrieve the version that was active on a specific date. If a `version_date` is provided, the endpoint returns the latest version with a start date less than or equal to the specified date. - [Create interest plan version](https://developers.pismo.io/pismo-docs/reference/patch-v1-interest-plan.md): Create a new version of an existing interest plan. This endpoint allows you to update specific fields while preserving others from the previous version. Key features: - Creates a new version with the specified `start_date`. - Updates only the provided fields—any field not specified inherits the value from the previous version. - Validates that the new `start_date` is after the `start_date` of the previous version. - Maintains immutable fields like `interest_type` and `tier_calculation`. - Preserves existing tiers when updating `interest_by_tiers`—only specified tiers are updated. This endpoint generates an [Interest plan created](https://developers.pismo.io/events/docs/interest-engine-interest-plan-creation-success-1) event. - [Create overdraft product](https://developers.pismo.io/pismo-docs/reference/post-overdraft-product.md): Create a new overdraft product.
The overdraft API enables a bank to set an overdraft limit for an account when the balance is insufficient. For details, refer to [How overdraft works](doc:how-overdraft-works).
This endpoint generates an [Overdraft product created](https://developers.pismo.io/events/docs/overdraft-product-creation-1) event. - [Get overdraft product](https://developers.pismo.io/pismo-docs/reference/get-overdraft-product.md): Get details of a specific overdraft product. - [Attach overdraft product to account](https://developers.pismo.io/pismo-docs/reference/post-attach-product-to-account.md): Attach an overdraft product to a bank account.
This endpoint generates an [Overdraft account attached](https://developers.pismo.io/events/docs/overdraft-product-account-attach-1) event. - [Detach overdraft product from account](https://developers.pismo.io/pismo-docs/reference/post-detach-product-from-account.md): Detach an overdraft product from a bank account.
This endpoint generates an [Overdraft account detached](https://developers.pismo.io/events/docs/overdraft-product-account-detach-1) event. - [Get overdraft product details for an account](https://developers.pismo.io/pismo-docs/reference/get-overdraft-account-attachment.md): Get the details of an overdraft product attached to an account. - [Attach overdraft product to program](https://developers.pismo.io/pismo-docs/reference/post-attach-product-to-program.md): Attach an overdraft product to a program.
This endpoint generates an [Overdraft program attached](https://developers.pismo.io/events/docs/overdraft-product-program-attach-1) event. - [Create recurrence](https://developers.pismo.io/pismo-docs/reference/post-recurrence-automatic.md): Initiate a payment request to create a Pix Automatic recurrence payment authorization. The Central Bank of Brazil (BACEN) created Pix Automatic - a feature that allows for scheduled and automatic recurring transfers. BACEN rules state that a recurrence must support retry attempts to allow execution of additional charges in case the original payment is not completed. **Retries flow** * If the payment order is not paid by 22:00 on the due date, and the recurrence allows retries, Pismo automatically generates a new payment order for that unpaid cycle. * The new payment order is created with type = `RETRY_OVERDUE`, and its due date is set to D+2, in compliance with Central Bank requirements. Retries can occur up to 3 times, within a maximum period of 7 days after the original due date. * After these 3 retry attempts, the payment order cycle can no longer be processed via the automatic Pix flow. The payee must manage further collection outside of this flow. For more information, refer to [Pix Automatic](https://developers.pismo.io/pismo-docs/docs/pix-automatic) - [Update automatic recurrence](https://developers.pismo.io/pismo-docs/reference/update-recurrence-automatic.md): Update automatic recurrence. - [Cancel recurrence](https://developers.pismo.io/pismo-docs/reference/cancel-recurrence-automatic.md): Cancel Pix Automatic recurrence - [Accept/reject recurrence authorization](https://developers.pismo.io/pismo-docs/reference/accept-reject-authorization.md): Pix Automatic payee recurrence payment authorization acceptance or rejection - [Update payment order amount](https://developers.pismo.io/pismo-docs/reference/update-order-automatic-pix.md): Update payment order amount. - [Cancel payment order](https://developers.pismo.io/pismo-docs/reference/cancel-automatic-pix-payment-order.md): Cancel the payment order in the provider. - [Resend payment order](https://developers.pismo.io/pismo-docs/reference/resend-automatic-pix-payment-order.md): Resend the payment order to the provider. You can use this endpoint when: 1. The payer's PSP did not accept the payment order and the status is `REJECTED` or `EXPIRED`, 2. When the payment order was accepted, but the Pix transaction was not found by the due date, with status `CANCELLED`. In these cases, the payment order can be resent to trigger a new attempt to process the payment. - [List recurrences](https://developers.pismo.io/pismo-docs/reference/list-recurrence-automatic.md): List Pix Automatic recurrences. By default, recurrences from the last 30 days with 20 records per page are returned, but you can use the `beginDate` and `endDate` query parameters to specify a different date range. - [Get recurrence](https://developers.pismo.io/pismo-docs/reference/get-recurrence-automatic.md): Get Pix Automatic recurrence - [List recurrence authorizations](https://developers.pismo.io/pismo-docs/reference/list-authorizations.md): List Pix Automatic recurrence authorizations. By default, recurrences authorizations from the last 30 days with 20 records per page are returned, but you can use the `beginDate` and `endDate` query parameters to specify a different date range. - [List payment orders](https://developers.pismo.io/pismo-docs/reference/list-payment-orders.md): List payment orders. By default, payment orders from the last 30 days with 20 records per page are returned, but you can use the `beginDate` and `endDate` query parameters to specify a different date range. - [Get payment order](https://developers.pismo.io/pismo-docs/reference/get-automatic-pix-payment-order.md): Get payment order information with end-to-end ID, the Pix transaction identifier from the Central Bank of Brazil (BACEN) - [Create key entry](https://developers.pismo.io/pismo-docs/reference/post-v2-pix-keys-create.md): Creates a new DICT key entry for the user. The Banco Central do Brazil (BCB) maintains Pix keys in the Diretório de Identificadores de Contas Transacionais (DICT), a national Pix key registry and database. On PSP timeout, a `202 Accepted` with a key status = `PROCESSING` reponse is returned and the process continues asynchronously, eventually emitting a success or error event. This endpoint generates a Pix key status changed event. For more information, refer to the [Pix instant payments](doc:pix-instant-payments) guide. - [List user keys](https://developers.pismo.io/pismo-docs/reference/get-v2-pix-keys.md): Get a list of user keys based on the Pismo account ID, which is parsed from the account token. - [Update key entry](https://developers.pismo.io/pismo-docs/reference/patch-v2-pix-keys.md): Update the DICT key entry. On PSP timeout, a `202 Accepted` response with a key status = `PROCESSING` is returned and the process continues asynchronously, eventually emitting a success or error event. This endpoint generates a Pix key status changed event. - [Delete key](https://developers.pismo.io/pismo-docs/reference/post-v2-pix-keys-delete.md): Deletes a user DICT key entry. On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronously, eventually emitting a success or error event. This endpoint generates a Pix key status changed event. - [Get key](https://developers.pismo.io/pismo-docs/reference/post-v2-pix-keys-search.md): Searches for a DICT key entry returning the owner information. - [Validate key](https://developers.pismo.io/pismo-docs/reference/post-v2-pix-keys-validate.md): Validates a key locally (if Pismo holds the ownership of it) or directly in DICT (for external keys). It returns related information along with the `end_to_end_id` you are **required** to pass to start a Pix transaction with the [Perform pix-out transfer](ref:post-pix-out-transfer) endpoint. This call should only be used to initate a payment, it does not return key information. - [Check DICT keys](https://developers.pismo.io/pismo-docs/reference/post-check-dict-keys.md): Check that a list of key(s) exist in DICT, a Brazilian national Pix registery and database. Keys can be generated from an email address, a mobile phone number, a Tax ID number, or an EVP (virtual payment address). - [Create key claim](https://developers.pismo.io/pismo-docs/reference/post-dict-key-claim.md): Register a DICT claim for a key. The Brazil Central Bank maintains Pix keys in the Diretório de Identificadores de Contas Transacionais (DICT), a national Pix key registry and database. On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronous, eventually emitting a claim successful creation event. This endpoint generates a Pix key claim status changed event. For more information, refer to [Pix key transfer (key claim)](doc:pix-instant-payments#pix-key-transfer-key-claim). - [List key claims](https://developers.pismo.io/pismo-docs/reference/get-dict-key-claims.md): List key DICT claims - [Confirm key claim](https://developers.pismo.io/pismo-docs/reference/post-confirm-dict-claim.md): Confirm a DICT claim for a key. On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronously and, when successful, emits an event. This endpoint generates a Pix key claim status changed event. For more information, refer to [Pix key transfer (key claim)](doc:pix-instant-payments#pix-key-transfer-key-claim). - [Cancel key claim](https://developers.pismo.io/pismo-docs/reference/post-cancel-dict-claim.md): Cancel a key's DICT claim. The table below defines, depending on the reason and type, who can cancel. For more information, refer to Pix key transfer (key claim) * `OWNERSHIP` - Transfer key ownership between users in the same or another bank. * `PORTABILITY` - Transfer key ownership for the same user to another bank.
OWNERSHIP PORTABILITY
Reason Donor Claimer Donor Claimer
  WAITING_RESOLUTION CONFIRMED
USER_REQUESTED √ √ √  
ACCOUNT_CLOSURE √ √ √
FRAUD √ √ √ √ √
DEFAULT_OPERATION √ √
RECONCILIATION √ √
On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronously, eventually emitting an event if it succeeds. This endpoint generates a Pix key claim status changed event. - [Complete key claim](https://developers.pismo.io/pismo-docs/reference/post-complete-dict-claim.md): Complete a DICT claim for a key. On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronously, eventually emitting an event if it succeeds. This endpoint generates a Pix key claim status changed event. For more information, refer to [Pix key transfer (key claim)](doc:pix-instant-payments#pix-key-transfer-key-claim). - [Create infraction report (outdated)](https://developers.pismo.io/pismo-docs/reference/post-v2-pix-infraction-create.md): This endpoint is outdated and no longer works. It is recommended you call [Create funds recovery](https://developers.pismo.io/pismo-docs/reference/post-create-funds-recovery) instead. Creates an infraction report. Both the debited participant and the credited participant can create an infraction report. For refund requests, the original transaction payer's payment service provider (PSP) **must** create the report. Only the PSP or the original transaction's recipient can cancel a refund. On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronously, eventually emitting a success or failure event. This endpoint generates a Pix infraction status changed event. - [List account infractions](https://developers.pismo.io/pismo-docs/reference/get-v2-pix-account-infractions.md): List account infraction notifications. Notifications are sorted in ascending order by the `bacen_last_modified_datetime` response return field. - [Close infraction report](https://developers.pismo.io/pismo-docs/reference/post-v2-pix-infraction-close.md): Closes an infraction report. Only the counterparty participant can close an infraction report. The operation is idempotent. If you try to close the report again with the same parameters, you will get the same response as the first time. On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronously, eventually emitting a success or failure event. This endpoint generates a Pix infraction status changed event. - [Cancel infraction report](https://developers.pismo.io/pismo-docs/reference/post-v2-pix-infraction-cancel.md): Cancel the infraction report. Only the participant who created the report can cancel it and the report's status **must** be `OPEN` or `ACKNOWLEDGED`. The operation is idempotent. If you try to cancel the report again with the same parameters, you will get the same response as the first time. On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronously, eventually emitting a success or failure event. This endpoint generates a Pix infraction status changed event. - [Get infraction report](https://developers.pismo.io/pismo-docs/reference/get-v2-pix-infraction.md): Get an infraction report's details. - [Update infraction report (outdated)](https://developers.pismo.io/pismo-docs/reference/patch-v2-pix-infraction.md): This endpoint is outdated and no longer works. It is recommended you call [Update funds recovery](https://developers.pismo.io/pismo-docs/reference/patch-funds-recovery). Update some infraction report fields. Fields not passed are not updated. To call this endpoint, the infraction report status is **REQUIRED** to be `OPEN` or `ACKNOWLEDGED`. The endpoint generates a [Pix infraction status changed](https://developers.pismo.io/events/docs/pix-dict-infraction-status-change-1) event. - [List infraction reports](https://developers.pismo.io/pismo-docs/reference/get-v2-pix-infraction-search.md): Get a participant's infraction notifications. Notifications are sorted in ascending order by the `bacen_last_modified_datetime` response return field. - [Create funds recovery [beta]](https://developers.pismo.io/pismo-docs/reference/post-create-funds-recovery.md): Creates and establishes a new funds recovery to track and block diverted funds in Pix fraud cases. The tracking follows the chain of subsequent transactions starting from the original fraudulent transaction. **Automated flow** DICT manages the entire process automatically. You only define the initial parameters and the system executes tracking, prioritization, and blocking. **Use for**: Standard cases, high volume of recoveries, or when you trust DICT's default algorithm. **Notes:** * Fraudulent transactions must have occurred less than **80 days** ago * Only the **debtor participant** (payer) can create funds recovery * Recipient PSPs have **7 calendar days** to analyze infraction notifications * Refund must be initiated within **72 hours** after analysis completion * Once refunding starts, the process **cannot be cancelled** Thie endpoint generates a [Pix funds recovery status changed](https://developers.pismo.io/events/docs/pix-dict-funds-recoveries-status-change-1) event. For more information refer to [Pix funds recovery](doc:pix-funds-recovery). - [List account fund recoveries [beta]](https://developers.pismo.io/pismo-docs/reference/list-account-fund-recoveries.md): Get all fund recoveries for an account - [List funds recovery infractions [beta]](https://developers.pismo.io/pismo-docs/reference/post-get-funds-recovery-infractions.md): Get a list of infractions for a funds recovery - [List funds recovery refund requests [beta]](https://developers.pismo.io/pismo-docs/reference/post-get-funds-recovery-refunds.md): Get a list of refund requests for a funds recovery - [Get funds recovery [beta]](https://developers.pismo.io/pismo-docs/reference/post-get-funds-recovery.md): Get a funds recovery. Customers should use this endpoint to monitor and track progress, such as checking status after asynchronous operations or audit closed cases. - [Get tracking graph [beta]](https://developers.pismo.io/pismo-docs/reference/get-refund-recovery.md): Get tracking graphs. Retrieves the tracking graph that maps the chain of subsequent transactions originated from the dispersion of fraudulent funds. The graph identifies people, accounts, and transactions involved in the movement of diverted funds. You can call this endpoint if you are: * The funds recovery creator participant * Counterparty participants who received related infraction notifications - [Initiate refund funds recovery [beta]](https://developers.pismo.io/pismo-docs/reference/post-refund-recovery.md): Initiate funds recovery refund stage, after the recipient PSPs have analyzed (`status` = `ANALYSED`) all the infraction notifications. This is the process' final step where funds are effectively returned to the victim's account. Before requesting the refund, make sure that: * The recovery status = `ANALYSED` * You are the **creator** recovery participant * You are within the **72-hour** deadline after receiving the `FUNDS_RECOVERY_ANALYSED` event * There is at least one **accepted** infraction notification (status = `ACCEPTED`) Thie endpoint generates a [Pix funds recovery status changed](https://developers.pismo.io/events/docs/pix-dict-funds-recoveries-status-change-1) event. For more information refer to [Pix funds recovery](doc:pix-funds-recovery). - [Cancel funds recovery [beta]](https://developers.pismo.io/pismo-docs/reference/post-cancel-funds-recovery.md): Cancel funds recovery Statuses that allow cancellation: | Status | Can Cancel? | Note | |--------|-------------|------| | `CREATED` | Yes | Before any processing | | `TRACKED` | Yes | After graph creation | | `AWAITING_ANALYSIS` | Yes | During analysis period (7 days) | | `ANALYSED` | Yes | After analysis completed, before refund | | `REFUNDING` | No | Refunds already started - irreversible process | | `COMPLETED` | No | Process already finished | When a recovery is cancelled: * Status changes to `CANCELLED` * All linked infraction notifications are automatically cancelled * Receiver PSPs must unblock the resources that were blocked * Tracking graph remains available for audit * Process cannot be undone (but new recovery can be created) Thie endpoint generates a [Pix funds recovery status changed](https://developers.pismo.io/events/docs/pix-dict-funds-recoveries-status-change-1) event. - [Update funds recovery](https://developers.pismo.io/pismo-docs/reference/patch-funds-recovery.md): Update some funds recovery fields. **Note:** The update is only possible when the record is in `CREATED`, `TRACKED`, or `AWAITING_ANALYSIS` states. - [Create fraud marker](https://developers.pismo.io/pismo-docs/reference/post-v2-pix-fraud-marker-create.md): Creates a fraud marker. On PSP timeout, a `202 Accepted` response is returned with a fraud marker ID. The process continues asynchronously and, if it doesn't succeed, a failure event is emitted. This endpoint generates a Fraud Marker registration event or failure event. - [Get fraud marker](https://developers.pismo.io/pismo-docs/reference/get-v2-pix-fraud-marker.md): Get fraud marker details - [Cancel fraud marker](https://developers.pismo.io/pismo-docs/reference/post-v2-pix-fraud-marker-cancel.md): The participant who created the fraud marker can call this endpoint. In the case of a fraud marker created as a result of closing an infraction report, the participant who created it can cancel it, in addition to the participant who closed the notification. On PSP timeout, a `202 Accepted` response with a fraud marker ID is returned. The process continues asynchronously and, if it doesn't succeed, a failure event is emitted. This endpoint generates a Fraud Marker registration event or failure event. - [Get anti-fraud statistics by key](https://developers.pismo.io/pismo-docs/reference/post-v2-antifraud-statistics-key.md): Gets anti fraud statistics based on key. - [Get anti-fraud statistics by document number](https://developers.pismo.io/pismo-docs/reference/post-v2-antifraud-statistics-document-number.md): Gets anti fraud statistics based on document number. - [List fraud markers](https://developers.pismo.io/pismo-docs/reference/post-list-fraud-markers.md): List fraud markers - [Get PIX client statistics](https://developers.pismo.io/pismo-docs/reference/get-v2-pix-statistics.md): Retrieve client account aggregated PIX statistics from BACEN DICT. **Statistics include:** - **SPI settlements**: count of settlements over the last 90 days, 12 months, and 60 months - **Fraud markers**: categorized fraud report counts (application frauds, mule accounts, scammer accounts, etc.) - **Infraction reports**: open reports, distinct reporters, and rejected reports counts - **Entries**: number of registered accounts linked to the client Statistics are pre-computed and cached. Use `force_update=true` to trigger a fresh computation from BACEN DICT. - [Create refund request](https://developers.pismo.io/pismo-docs/reference/post-register-dict-refund.md): Create a DICT refund request. On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronously, eventually emitting an event if it succeeds. This endpoint generates a Pix reversal (refund) status changed event. - [List refunds](https://developers.pismo.io/pismo-docs/reference/get-list-dict-refunds.md): List DICT refunds for an organization. - [Get refund](https://developers.pismo.io/pismo-docs/reference/get-dict-refund.md): Get DICT refund - [Cancel refund](https://developers.pismo.io/pismo-docs/reference/post-cancel-dict-refund.md): Cancel a DICT refund request. On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronously, eventually emitting an event if it succeeds. This endpoint generates a Pix reversal (refund) status changed event. - [Close refund](https://developers.pismo.io/pismo-docs/reference/post-close-dict-refund.md): Close a DICT refund request. On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronously, eventually emitting an event if it succeeds. This endpoint generates a Pix reversal (refund) status changed event and a Pix transaction reconciliation event. - [List Pix participants](https://developers.pismo.io/pismo-docs/reference/get-v2-pix-dict-participants.md): Returns the list of all Pix participants (institutions) registered in the BCB DICT, including each participant's ISPB, institution name, type and Pix participation modality. This endpoint proxies the request in real time to the configured DICT provider — no local cache or database is involved — so response latency reflects the upstream provider. - [Pix-out transfer](https://developers.pismo.io/pismo-docs/reference/post-pix-out-transfer.md): Perform a Pix-out transfer. If you are using a key or QR Code, you need to call Validate DICT key or Get and validate QR Code before calling this endpoint. You need to enter the `end_to_end_id` returned from those calls here. Validation and transaction need to occur within 10 seconds. If you are not using a key or QR Code, this endpoint generates and returns an `end_to_end_id` value you can use in other endpoints. The `end_to_end_id` field is a Brazil Central Bank (BCB) requirement to track Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction and 2. Confirm a transaction. The `end_to_end_id` is sent to the BCB in both steps in order to identify all transaction information. This endpoint generates a Pix-out notification received event and a Pix reconciliation notification received event. This endpoint also generates a Pix-in notification received event when the funds are deposited in the payee's account, which can be a Pismo account or an external account. For all events, the `status` or `result` field indicates operation success or failure. If the request times out and the `end_to_end_id` was not returned, use the [Get Pix transaction by client request ID](ref:post-transactions-search) endpoint passing the same `Idempotency-Key` sent in this request as the `client_request_id` to recover the transaction status. For more information, see the [Pix instant payments](doc:pix-instant-payments) guide. - [Pix reversal](https://developers.pismo.io/pismo-docs/reference/post-pix-reversal.md): Reverse a Pix-out transfer. This endpoint generates a Pix-out reversed event and a Pix reconciliation notification received event. This endpoint also generates a Pix-in reversed event when the funds are transferred from the payee's account, which can be a Pismo account or an external account. For all events, the `status` or `result` field indicates operation success or failure. For more information, see the [Pix instant payments](doc:pix-instant-payments) guide. - [Validate QR Code](https://developers.pismo.io/pismo-docs/reference/post-qr-code.md): Retrieve and validate Pix QR Code. - [List account receipts](https://developers.pismo.io/pismo-docs/reference/get-receipts.md): Retrieve account's receipts with filter options. The account is parsed from the account authorization token. - [Get Pix transaction by end-to-end ID](https://developers.pismo.io/pismo-docs/reference/get-transaction-e2e.md): Retrieve transaction information given an `end-to-end` value in the path. **Note:** This endpoint takes an account token - an access token encoded with a Pismo accound ID. - [Get transaction from provider](https://developers.pismo.io/pismo-docs/reference/get-pix-transaction.md): Get Pix transaction from the provider given its type and end-to-end-ID in the path. Can be used to verify that both provider and Pismo have the same information. **Note:** This endpoint takes an account token - an access token encoded with a Pismo accound ID. - [Get Pix transaction by client request ID](https://developers.pismo.io/pismo-docs/reference/post-transactions-search.md): Get a Pix transaction using the `client_request_id` passed when the transaction was created. The `client_request_id` is the value passed in the `Idempotency-Key` header when creating a cashin (Pix-in) or cashout (Pix-out) transaction. This endpoint is useful, for example, when a [Pix-out transfer](ref:post-pix-out-transfer) request times out and the client does not yet have the `end_to_end_id` needed to query the transaction through the [Get Pix transaction by end-to-end ID](ref:get-transaction-e2e) endpoint. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Schedule transfer(s) V2](https://developers.pismo.io/pismo-docs/reference/post-schedule-pix-payment.md): Schedule a Pix-out transfer or Pix-out recurring transfers. This endpoint gives you more scheduling options than the version 1 [Schedule transfer](https://developers.pismo.io/pismo-docs/reference/post-schedule) endpoint. These include additional options (`scheduler_details` object) for recurring transfers. As with the [Pix-out transfer](ref:post-pix-out-transfer) endpoint, if you are using a key or QR Code, you need to call Validate DICT key or Get and validate QR Code before calling this endpoint. You need to enter the `end_to_end_id` returned from those calls here. If you are not using a key or QR Code, this endpoint generates and returns an `end_to_end_id` value you can use in other endpoints. The `end_to_end_id` field is a Brazil Central Bank (BCB) requirement to track Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction and 2. Confirm a transaction. The `end_to_end_id` is sent to the BCB in both steps in order to identify all transaction information. This endpoint directly generates an [Instant pay scheduler status changed](https://developers.pismo.io/events/docs/instantpay-scheduler-scheduler-status-change-1) event. To create a recurring payment, set `type` = `RECURRING` and pass a value for `cycle`. This property has 2 attributes and should be set as shown in the sample table below: `cycle.type` | `cycle.count` | New transaction created every: ---------- | ----------- | ------------ `DAILY` | 5 | 5 days `WEEKLY` | 2 | 2 weeks `MONTHLY` | 1 | 1 month `MONTHLY` | 2 | 2 months `YEARLY` | 1 | 1 year **Notes** * `WEEKLY` sets the `start_date` weekday. For a scheduler with `start_date` = Thursday, the next transaction is always on a Thursday. * `MONTHLY / YEARLY` sets the `start_date` day. For a scheduler with `start_date` = `2024-10-12`, the next transaction is always created on day 12 of each cycle count. Now, for days `29`, `30` and `31`, the scheduler uses the previous month's last day when that day doesn't exist in the current month. For example, considering a scheduler starting at `2024-01-30`, the next transaction is created on `2024-02-29`. **Events** * When the transfer takes place, Pix-out notification received and Pix reconciliation notification received events are generated. * Also, when the transfer takes place, a Pix-in notification received event is generated when the funds are deposited in the payee's account, which can be a Pismo account or an external account. * For all events, the `status` or `result` field indicates operation success or failure. For more information, refer to the [Pix instant payments](doc:pix-instant-payments) guide. **Note:** This endpoint takes an account token - an access token encoded with a Pismo accound ID. - [List scheduled Pix transfers](https://developers.pismo.io/pismo-docs/reference/list-scheduled-transfers.md): List scheduled Pix transfers with filtering options. - [Execute scheduled Pix-out transfer in advance](https://developers.pismo.io/pismo-docs/reference/advance-pix-out-execution.md): Perform a scheduled Pix-out transfer execution in advance. A scheduled transfer can have many executions if, for example, it is recurring. This endpoint generates a Instant pay execution status changed event. - [Get scheduled transfer](https://developers.pismo.io/pismo-docs/reference/get-scheduled-pix-payment.md): Get a scheduled Pix payment. **Note:** This endpoint takes an account token - an access token encoded with a Pismo accound ID. - [Cancel scheduled transfer V2](https://developers.pismo.io/pismo-docs/reference/delete-cancel-pix-out.md): Cancel scheduled Pix transfer. This endpoint generates a Instant pay scheduler status change event. - [List Pix scheduler executions](https://developers.pismo.io/pismo-docs/reference/get-scheduler-executions.md): List Pix payment scheduler executions - scheduled Pix transfers that have run to completion. A scheduled transfer can have many executions if, for example, it is recurring. - [Cancel Pix-out scheduled execution](https://developers.pismo.io/pismo-docs/reference/cancel-pix-out-execution.md): Perform a Pix-out execution cancel. A scheduled transfer can have many executions if, for example, it is recurring. This endpoint generates a Instant pay execution status changed event. **Note:** This endpoint takes an account token - an access token encoded with a Pismo accound ID. - [Schedule transfer [deprecated]](https://developers.pismo.io/pismo-docs/reference/post-schedule.md): This endpoint is `DEPRECATED`. It is recommended you call [Schedule Transfer(s) V2](ref:post-schedule-pix-payment) instead. Schedule a Pix-out transfer for a future date. As with the [Pix-out transfer](ref:post-pix-out-transfer) endpoint, if you are using a key or QR Code, you need to call Validate DICT key or Get and validate QR Code before calling this endpoint. You need to enter the `end_to_end_id` returned from those calls here. If you are not using a key or QR Code, this endpoint generates and returns an `end_to_end_id` value you can use in other endpoints. The `end_to_end_id` field is a Brazil Central Bank (BCB) requirement to track Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction and 2. Confirm a transaction. The `end_to_end_id` is sent to the BCB in both steps in order to identify all transaction information. When the transfer takes place, Pix out notification received and Pix reconciliation notification received events are generated. Also, when the transfer takes place, a Pix-in notification received event is generated when the funds are deposited in the payee's account, which can be a Pismo account or an external account. For all events, the `status` or `result` field indicates operation success or failure. For more information, see the [Pix instant payments](doc:pix-instant-payments) guide. - [List account scheduled transfers](https://developers.pismo.io/pismo-docs/reference/get-schedules.md): Retrieve an account's scheduled transfers. - [Cancel scheduled transfer](https://developers.pismo.io/pismo-docs/reference/delete-transfer.md): Cancel a scheduled Pix-out transfer. - [Validate bank as withdrawal servicer](https://developers.pismo.io/pismo-docs/reference/post-validate.md): Validate if a participant (bank) is a withdrawal service facilitator or not. - [Get withdrawal service agent information](https://developers.pismo.io/pismo-docs/reference/get-withdrawal-service-point.md): Get information about withdrawal service agents (WSA) or the direct ISP participant providing the withdrawal service. A WSA is a service provider that facilitates the withdrawal of funds in Pix. It acts as a bridge between Pix and customers who want to withdraw funds from their accounts. A WSA point is a location or access point where users can physically or digitally access WSA services. This could be a physical location such as a bank branch or retail store or digital acceess point such as a mobile app or web portal. - [Create dynamic COB QR Code](https://developers.pismo.io/pismo-docs/reference/post-create-cob.md): Generate a new dynamic COB QR Code and EMV (Europay Mastercard Visa) string. COB is short for *cobranca*, which means *charge* in Portuguese. A COB QR Code has an expiration date while a COBV QR Code has a due date, fine, interest, and rebates. For more information, refer to [Pix and QR Codes](doc:pix-and-qr-codes). Typically, this endpoint is used to generate a dynamic QR Code for the [Pix instant payments](doc:pix-instant-payments) system. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Update dynamic COB QR Code](https://developers.pismo.io/pismo-docs/reference/patch-generate-qrcode-cob.md): Update COB QR Code information. The entire QR Code is updated. If a parameter is not passed, the current value (if any) is emptied. - [Create dynamic COBV QR Code](https://developers.pismo.io/pismo-docs/reference/post-qrcode-cobv.md): Generate a new COBV QR Code image and EMV (Europay Mastercard Visa) string. COB is short for *cobranca*, which means *charge* in Portuguese. A COB QR Code has an expiration date while a COBV QR Code has a due date, fine, interest, and rebates. For more information, refer to [Pix and QR Codes](doc:pix-and-qr-codes). Typically, this endpoint is used to generate a dynamic QR Code for the [Pix instant payments](doc:pix-instant-payments) system. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Update dynamic COBV QR Code](https://developers.pismo.io/pismo-docs/reference/patch-qrcode-cobv.md): Update dynamic COBV QR Code The entire QR Code is updated. If a parameter is not passed, the current value (if any) is emptied. - [Get QR Code information and calculate payment](https://developers.pismo.io/pismo-docs/reference/get-qrcode-jws.md): Get QR Code information and, at the same time, calculate payment information depending on query parameters passed. - [Create recurrent COB QR Code](https://developers.pismo.io/pismo-docs/reference/post-create-recurrence-cob.md): Create a COB QR Code for a recurring payment as a EMV (Europay Mastercard Visa) string. COB is short for *cobranca*, which means charge in Portuguese. A COB QR Code has an expiration date while a COBV QR Code has a due date, fine, interest, and rebates. For more information, refer to [Pix and QR Codes](doc:pix-and-qr-codes). **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Create recurrent COBV QR Code](https://developers.pismo.io/pismo-docs/reference/post-create-recurrence-cobv.md): Create a COBV QR Code for a recurring payment as a EMV (Europay Mastercard Visa) string. For more information, refer to [Pix and QR Codes](doc:pix-and-qr-codes). **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Create recurrent static QR Code](https://developers.pismo.io/pismo-docs/reference/post-create-static.md): Create a recurrent static QR Code and EMV (Europay Mastercard Visa) string. For more information, refer to [Pix and QR Codes](doc:pix-and-qr-codes). **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Create recurrent compound QR Code](https://developers.pismo.io/pismo-docs/reference/post-create-recurrence.md): Create a compound QR Code containing only recurring payment authorization configuration data. For more information, refer to [Pix and QR Codes](doc:pix-and-qr-codes). **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [List cards](https://developers.pismo.io/pismo-docs/reference/post-list-cards.md): Return active account card list - [Validate card data](https://developers.pismo.io/pismo-docs/reference/post-validate-card-data.md): Validate client card data for [Transfer funds](ref:post-funds-transfer) - [Transfer UPI funds](https://developers.pismo.io/pismo-docs/reference/post-funds-transfer.md): United Payments Interface (UPI) funds transfer for RuPay, an Indian card network. Before calling this endpoint, you can call [List cards](ref:post-list-cards) to get the `account_reference_number`. You should also call [Validate card](ref:post-validate-card-data) to make sure the card data for the transfer request is genuine. This endpoint generates a [Payment methods authorization created](https://developers.pismo.io/events/docs/payment-methods-authorization-1) event and a [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) event. This operation is **idempotent**, meaning, it can be applied multiple times, yet the outcome remains the same. To guarantee this, the request has an `external_transaction_id` field, which must be unique by transaction type in the context of the same account reference number. - [Get funds transfer status](https://developers.pismo.io/pismo-docs/reference/get-transfer-funds-status.md): Get funds transfer status - [Get balance for account](https://developers.pismo.io/pismo-docs/reference/post-balance-enquiry.md): Balance inquiry - [Get card bill](https://developers.pismo.io/pismo-docs/reference/post-card-bill.md): Return card bill details - [EMI select](https://developers.pismo.io/pismo-docs/reference/emi-select.md): United Payments Interface (UPI) funds Equated Monthly Installments (EMI) for RuPay, an Indian card network. Before calling this endpoint, you can call [List cards](ref:post-list-cards) to get the `account_reference_number`. You should also call [Validate card](ref:post-validate-card-data) to make sure the card data for the transfer request is genuine. This endpoint generates a [Payment methods authorization created](https://developers.pismo.io/events/docs/payment-methods-authorization-1) event and a [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) event. This operation is **idempotent**, meaning, it can be applied multiple times, yet the outcome remains the same. To guarantee this, the request has an `external_transaction_id` field, which must be unique by transaction type in the context of the same account reference number. - [Send Faster Payment [beta]](https://developers.pismo.io/pismo-docs/reference/post-create-fps.md): Send a Faster Payments payment. The Faster Payments System (FPS) is a UK service that allows near-instant electronic money transfers between banks. **Notes:** * Before calling this endpoint, you **must** call [Confirmation of Payee](ref:post-cop-verification) to verify the payee. * In case of failure, the transaction is updated with `status` = `CANCELLED`, and the `status_reason` field explains why. * If the counterparty bank rejects the transaction, the transaction is still considered `SETTLED` and, when the provider webhook return is processed, a new [FPS out return](https://developers.pismo.io/events/docs/fps-fps-out-return-status-change-1) event is generated and the amount is credited back to the debtor's account. * This endpoint generates a [FPS out payment transaction](https://developers.pismo.io/events/docs/fps-fps-out-status-change-1) event. - [Get FPS transaction [beta]](https://developers.pismo.io/pismo-docs/reference/get-fps-in-transaction.md): Gets a FPS transaction given its end-to-end identifier in the path. The Faster Payments System (FPS) is a UK service that allows near-instant electronic money transfers between banks. - [Cancel FPS inbound transaction [beta]](https://developers.pismo.io/pismo-docs/reference/post-cancel-fps.md): Call this endpoint to cancel the suspended transaction which was kept on hold based on client's antifraud provider analysis and return the transaction. This endpoint generates a [FPS inbound payment processed](https://developers.pismo.io/events/docs/fps-fps-in-status-change-1) event with `status` = `CANCELLED`. - [Release FPS inbound transaction [beta]](https://developers.pismo.io/pismo-docs/reference/post-release-fps.md): This endpoint moves the suspended transaction amount from additional funds to available balance and marks the transaction as settled. This endpoint generates a [FPS inbound payment processed](https://developers.pismo.io/events/docs/fps-fps-in-status-change-1) event with status `SETTLED`. - [Confirmation of payee [beta]](https://developers.pismo.io/pismo-docs/reference/post-cop-verification.md): Verify a beneficiary's account name before making an FPS payment using the [Confirmation of Payee (CoP)](https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/) service. CoP allows payers to check that the name they have for the intended recipient matches the actual name on the recipient's account, reducing the risk of fraud and misdirected payments. This verification does not create an FPS payment transaction. The request is forwarded to the payment provider for real-time name verification. This endpoint generates a [CoP name verification requested](https://developers.pismo.io/events/docs/fps-cop-name-verification-submissions-1) event. The result is received in a [CoP name verification result received](https://developers.pismo.io/events/docs/fps-cop-name-verification-admissions-1) event. - [Return FPS payment [beta]](https://developers.pismo.io/pismo-docs/reference/post-return-fps.md): Manually trigger a return for a previously credited FPS inbound transaction. This endpoint allows clients to initiate a return of funds for an inbound FPS payment that has already been credited to the beneficiary's account. The return is submitted to the payment provider (Form3) for processing. Returns initiated through this endpoint are marked with `return_origin` = `CLIENT` to distinguish them from provider-initiated returns. The `return_reason` must be one of the 14 standardized Form3 reason codes (`00000001` through `00000014`). This endpoint generates an [FPS inbound payment return processed](https://developers.pismo.io/events/docs/fps-fps-in-return-status-change-1) event with `return_origin` = `CLIENT`. - [Send BACS direct credit outbound payment [beta]](https://developers.pismo.io/pismo-docs/reference/post-create-bacs.md): Send a Bankers' Automated Clearing System (BACS) direct credit outbound payment. BACS is a UK service that facilitates electronic money transfers between banks within a 3-day settlement cycle— Day 1 (submission), Day 2 (processing), and Day 3 (clearing/credit). There are two main concepts in BACS: 1. **Direct credit** - A company can use this format to pay their employees. 2. **Direct debit** - When an electricity company charges their costumers recurrently it will have a subscription (called *mandates*). When a mandate is generated monthly, the originator creates a charge. When this charge comes to the client here at Pismo. Pismo then debits the customer account. Both of these methods generate a cashin, cashout, and return. For more information, refer to the [BACS guide](https://developers.pismo.io/pismo-docs/docs/banking-automated-clearing-system). **Notes:** * Participating accounts must be [registered as a UK account](https://developers.pismo.io/pismo-docs/reference/post-intl-bank-accounts-v2-accounts-account-id-bank-accounts-uk-scan) * In case of failure, the transaction is updated with `status` = `CANCELLED` and the `status_reason` field details why it failed. * If the counterparty bank rejects the transaction, the transaction is still considered `SETTLED` and, when the provider webhook return is processed, a new [BACS direct credit outbound return payment processed](https://developers.pismo.io/events/docs/bacs-direct-credit-out-return-status-change-1) event is generated and the amount is credited back to the debtor's account. * This endpoint generates a [BACS direct credit outbound payment processed](https://developers.pismo.io/events/docs/bacs-direct-credit-out-status-change-1) event. - [Get BACS transaction [beta]](https://developers.pismo.io/pismo-docs/reference/get-bacs-in-transaction.md): Get a BACS transaction given its ID in the path. - [Cancel BACS inbound transaction [beta]](https://developers.pismo.io/pismo-docs/reference/post-cancel-bacs.md): Cancel a suspended transaction, which was kept on hold based on client's anti-fraud (AF) provider analysis, and return the transaction. **Suspense transaction flow** You can use the suspense transaction flow to manage incoming BACS transactions that have been temporarily placed on hold due to suspected fraud pending a decision from the client's anti-fraud (AF) provider. **Supported scenarios:** * An incoming (cash-in) BACS transaction is received. * Client' s anti-fraud provider returns "hold" instead of approve or reject. * Pismo places the transaction amount into additional fund (unavailable balance) so the beneficiary cannot use the funds until a final decision is made. * The client later calls Pismo's [release](ref:post-release-bacs-1) or cancel endpoints to finalize the transaction. This endpoint generates a [BACS direct credit inbound payment processed](https://developers.pismo.io/events/docs/bacs-direct-credit-in-status-change-1) event with `status` = `CANCELLED`. - [Release BACS inbound transaction [beta]](https://developers.pismo.io/pismo-docs/reference/post-release-bacs.md): Move a suspended transaction amount from additional funds to available balance and mark the transaction as settled. **Suspense transaction flow** You can use the suspense transaction flow to manage incoming BACS transactions that have been temporarily placed on hold due to suspected fraud pending a decision from the client's anti-fraud (AF) provider. **Supported scenarios:** * A incoming (cash-in) BACS transaction is received. * Client' s anti-fraud provider returns "hold" instead of approve or reject. * Pismo places the transaction amount into additional funds (unavailable balance) so the beneficiary cannot use the funds until a final decision is made. * The client later calls Pismo's release or [cancel](ref:post-cancel-bacs-1) endpoints to finalize the transaction. This endpoint generates a [BACS direct credit inbound payment processed](https://developers.pismo.io/events/docs/bacs-direct-credit-in-status-change-1) event with status `SETTLED`. - [Reverse BACS direct credit outbound payment [beta]](https://developers.pismo.io/pismo-docs/reference/post-reversal-bacs.md): Reverse a BACS direct credit outbound payment that is on hold. A reversal is only allowed when: - The payment is an outbound payment with status `HOLD` - The reversal is requested on the same day as the payment creation date This endpoint generates a [BACS direct credit outbound reversal processed](https://developers.pismo.io/events/docs/bacs-direct-credit-out-reversal-status-change-1) event. - [Return BACS direct credit inbound payment [beta]](https://developers.pismo.io/pismo-docs/reference/post-bacs-client-return.md): Initiates a client return for a settled BACS direct credit inbound payment. The return amount must match the original transaction amount exactly, since the platform does not allow partial returns. The platform permits only one return per original transaction. Returns initiated through this endpoint are marked with `return_origin` = `CLIENT` to distinguish them from system-initiated returns (`return_origin` = `SYSTEM`). This endpoint generates a [BACS direct credit inbound return payment processed](https://developers.pismo.io/events/docs/bacs-direct-credit-in-return-status-change-1) event with `return_origin` = `CLIENT`. - [List BACS direct credit transactions [beta]](https://developers.pismo.io/pismo-docs/reference/get-bacs-directcredit-list.md): List BACS direct credit transactions for an account. The account is parsed from the account token. - [List BACS direct debit mandates [beta]](https://developers.pismo.io/pismo-docs/reference/get-bacs-mandate-list.md): List BACS direct debit mandates for an account. The account is parsed from the account token. - [List BACS direct debit transactions [beta]](https://developers.pismo.io/pismo-docs/reference/get-bacs-directdebit-list.md): List BACS direct debit transactions. - [Create BACS mandate [beta]](https://developers.pismo.io/pismo-docs/reference/post-create-mandate.md): Create a BACS direct debit mandate. A BACS direct debit mandate captures a payer's authorisation, taken from a signed paper form, for a business to collect direct debit payments from their UK bank account through the BACS scheme. **Notes:** * The operation is idempotent via the `Idempotency-key` header. Repeating the same key replays the original mandate; reusing the same `reference` with a different key is rejected with a **409 Conflict**. * Creation does not generate an event. Subsequent status transitions generate a [BACS mandate status changed](https://developers.pismo.io/events/docs/bacs-mandate-status-change-1) event (for example `SUBMITTED`, `CONFIRMED`, `FAILED`). - [Amend BACS mandate [beta]](https://developers.pismo.io/pismo-docs/reference/patch-amend-mandate.md): Amend a BACS direct debit mandate. Registers a change to a mandate's debtor and/or beneficiary details, applied asynchronously through the BACS scheme. **Notes:** * The amend is persisted with `status` = `AMEND_PENDING`, and enqueued for the asynchronous submission worker, which submits it to Form3 through the PSP gateway. * Allowed only when the mandate is in `CREATED`, `SUBMITTED`, or `CONFIRMED`; any other state is rejected with a **409 Conflict** (`EBACS0103`). * `version` is a Form3 optimistic-concurrency passthrough that must equal the stored version; a mismatch is rejected with a **409 Conflict** (`EBACS0104`). This call does not increment this field. * This endpoint moves the mandate to `status` = `AMEND_PENDING` and generates a [BACS mandate status changed](https://developers.pismo.io/events/docs/bacs-mandate-status-change-1) event. Subsequent status transitions generate further events (for example `AMENDED`, `FAILED`). - [Cancel BACS mandate [beta]](https://developers.pismo.io/pismo-docs/reference/post-cancel-mandate.md): Cancel a BACS direct debit mandate. Cancel of an existing mandate, applied asynchronously through the BACS scheme. **Notes:** * The cancel is persisted with `status` = `CANCEL_PENDING` under the payer account, and enqueued for the asynchronous submission worker, which submits it to Form3 through the PSP gateway. * Allowed only when the mandate is in `SUBMITTED` or `CONFIRMED`; any other state is rejected with a **409 Conflict** (`EBACS0103`). * `version` is a Form3 optimistic-concurrency passthrough that must equal the stored version; a mismatch is rejected with a **409 Conflict** (`EBACS0104`). This call does not increment it. * The optional `status_reason` records why the mandate is being cancelled; it is persisted on the mandate and forwarded on the generated event. * This endpoint moves the mandate to `status` = `CANCEL_PENDING` and generates a [BACS mandate status changed](https://developers.pismo.io/events/docs/bacs-mandate-status-change-1) event. Subsequent status transitions generate further events (for example `CANCELLED`, `FAILED`). - [Simulate authorization](https://developers.pismo.io/pismo-docs/reference/post_v1-authorizations.md): You can use this endpoint to simulate a real-world authorization from the network in the sandbox environment. This simulation does not go through all the card network services as it would in production, but it does check for card status and balance. The call gives you a chance to see how Pismo might respond to a network authorization. The fields returned can be used to cancel or confirm the request with this endpoint. You can also use this endpoint to cancel (total or partial) the simulated authorization in the EXT/HOMOLOG environment. To cancel in the production environments, use the [Cancel authorization](ref:cancel-network-authorizations) endpoint. This endpoint generates the simulated [Network authorization received](https://developers.pismo.io/events/docs/networktransactions-network-authorization-1) event which you can receive and view. This event occurs in production when the Pismo platform cancels or confirms an authorization. You can also use this endpoint to test connectivity to your [anti-fraud webhook url](doc:anti-fraud-integration). For more information, see the [Simulate authorizations](doc:simulate-authorizations) guide. - [List account authorizations](https://developers.pismo.io/pismo-docs/reference/get-network-authorizations.md): List authorizations by account, tenant, or authorization ID. The response is an array of objects ordered by authorization ID. In descending order, the response includes every authorization for the account. Each page contains 20 items per page. If the authorization ID is used in the query parameter, the first record in the result will be the authorization related to this ID and the following results will be in descending order. - [Cancel authorization](https://developers.pismo.io/pismo-docs/reference/cancel-network-authorizations.md): Perform a full cancellation of an authorization. The authorization must have the status `PENDING` or `PROCESSED` and must also not have been previously confirmed (cleared). This endpoint generates a [Network authorization received](https://developers.pismo.io/events/docs/networktransactions-network-authorization-1) event. - [Create card](https://developers.pismo.io/pismo-docs/reference/post-v2-card.md): Create a virtual or physical (plastic/metal) card. Refer to the [Cards management](doc:cards-overview-1) guide for more information about physical and virtual cards. For more information about embossing, refer to [Embossing flows](doc:physical-card-embossing#embossing-flow). This endpoint generates a [Card created](https://developers.pismo.io/events/docs/cards-create-1) event. The card's PCI data is created asynchronously as is the Card created event. Any operation that tries to access a card before this event, such as update password or get PCI information, is going to return a **404, not found** error. - [Activate physical card](https://developers.pismo.io/pismo-docs/reference/put-v1-card-activate.md): A physical card is initally blocked for transactions until activated. This prevents unauthorized use until the cardholder takes delivery. You do not have to activate a card to tokenize it for a digital wallet. This endpoint generates a [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event. - [Get cards for customer and account](https://developers.pismo.io/pismo-docs/reference/get-v1-cards.md): Get cards for specified account and customer with paging and filter options. Accounts can have multiple customers, typically to accommodate primary and additional cardholders, but only one owner. There can only be one physical card per customer. A customer can have multiple virtual cards, but the card names have to be different. - [Get account cards](https://developers.pismo.io/pismo-docs/reference/get-v1-cards-by-account.md): Get cards for specified account with paging and filter options. The account is parsed from the token, which must be an account token. Accounts can have multiple customers, typically to accommodate primary and additional cardholders, but only one owner. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Get non-PCI card information](https://developers.pismo.io/pismo-docs/reference/get-v1-card.md): Get card non-sensitive (non-PCI) information. NOTE: This endpoint requires an account-specific access token - a token encoded with a Pismo account ID. - [Update card information](https://developers.pismo.io/pismo-docs/reference/patch-v2-card.md): Update card information - `name`, `transaction_limit`, `printed_name`, `contactless_enabled`, `abu_enabled`, or `metadata`.
This endpoint generates a [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Reset card ATC](https://developers.pismo.io/pismo-docs/reference/post-v2-card-atc-reset.md): Reset card ATC (Application Transaction Counter) in case of sync failure between what is saved in a card's memory and the incremented data. The ATC is a counter, maintained by the chip card application (incremented by the chip), that provides a sequential reference to each transaction. A duplicate ATC, a decrease in ATC, or a large jump in ATC values may indicate data copying or other fraud. For more information on how Pismo processes ATCs, refer to the [Application Transaction Counter (ATC)](https://developers.pismo.io/pismo-docs/docs/application-transaction-counter-atc) guide article. **Notes:** * ATC reset only occurs on the Pismo platform. When a new transaction occurs, the ATC is synchronized with the chip's ATC. * This endpoint takes an account token - an access token encoded with a Pismo account ID. For combo cards, whether the debit or credit ATC is reset depends on which account ID (credit or debit) is encoded with the access token. - [Reset password try count](https://developers.pismo.io/pismo-docs/reference/post-v2-card-password-reset.md): Unblock a card after it has exceeded its maximum password tries count. If the card is `BLOCKED`: * The status is changed to `NORMAL` * The counter is reset * An [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event is generated. If the card is `NORMAL`, `PENDING`, or `WARNING`, the counter is reset. For any other status, a 406 - range not satisfiable - error is returned. **Note**: This does not change the password recorded on an embossed card's chip. If the card is configured for offline password verification, you need to change the password on the physical card. To do that, you can use a [card script](doc:card-scripts). For more information, refer to the [Card lifecycle and statuses](doc:card-lifecycle-and-statuses) guide. - [Increase password try count](https://developers.pismo.io/pismo-docs/reference/post-v2-card-password-increase.md): Increase a card's password tries counter by 1. If the counter reaches the maximum number of tries configured in the program parameter for this and `block_card_exceeds_counter` is `true`, the card is blocked. When this happens: * The status is changed to `BLOCKED` * A [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event is generated. If the card's status is `CREATED`, the counter is increased, but the status does not change. For more information, refer to the [Card lifecycle and statuses](doc:card-lifecycle-and-statuses) guide. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Create combo card (deprecated)](https://developers.pismo.io/pismo-docs/reference/post-v1-combocard-relationship.md): Associates a customer's debit and credit accounts to create a combination card with both debit and credit payment capabilities that can be used as one embossed card. It is recommended you create a combination card using card modes as this endpoint will soon be deprecated. For more information, refer to the [mode documentation](doc:cards-overview-1#create-a-combination-card-with-card-modes) in the Cards management guide. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Reissue card](https://developers.pismo.io/pismo-docs/reference/post-v1-card-reissue.md): Reissue a physical (plastic/metal) or virtual card for a given customer/account. For information on card reissue scenarios and statuses, refer to the [Card reissuing](doc:card-reissuing) guide. This endpoint generates a [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event for the old card, and a [Card created](https://developers.pismo.io/events/docs/cards-create-1) event for the new card. The Card created event is generated asynchronously - any operation that tries to access a card before this event, such as update password or get PCI information, is going to return a **404, not found** error. **Notes:** * If an attempt is made to reissue a card that has already been reissued, the new card's data created in the previous reissue is returned, that is, another card is not created and events are not generated. * To update the new card with the old card's PIN, call [Get password ](ref:get-v2-card-password) for the old card, then update the new card's password with [Change card password](ref:put-v2-card-password) * To transfer tokens to the new card, set the `update_tokens` field to `true`. You can also do this later with the [Transfer card tokens to other card](ref:transfertokens) endpoint. * Currently, there is no way to transfer a card's PAN * This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Get card reissue reasons (outdated)](https://developers.pismo.io/pismo-docs/reference/get-v1-card-reissue-reasons.md): This endpoint is outdated, call the [List reissue reasons](ref:get-reissue-reasons) endpoint instead. Get all reissue reasons together with associated costs. To register reasons for reissue: [Open a Jira ticket](doc:opening-a-service-desk-ticket) with type = **Settings** and enter the data below: `cost` - Reissue cost value. This field is for information only - only issuers can make debit entries to a customer's account. `must_block` - Whether the card is canceled at reissue time or can transact until new card is activated. `description` - Reason description. `must_charge` - Will reissue be charged? This field is for information only as only the issuer can make debit entries to a customer's account. `type` - Issuer defined reissue reason enum value - [Create reissue reason](https://developers.pismo.io/pismo-docs/reference/create-reissue-reason.md): Create a new reissue reason. All fields are required when creating a new reason. - [List reissue reasons](https://developers.pismo.io/pismo-docs/reference/get-reissue-reasons.md): Returns a paginated list of reissue reasons for the tenant. Supports filtering by enabled status and cursor-based pagination. - [Update reissue reason](https://developers.pismo.io/pismo-docs/reference/update-reissue-reason.md): Updates an existing reissue reason. At least one field must be provided. Only the fields provided will be updated. - [Update card status](https://developers.pismo.io/pismo-docs/reference/put-v1-card-status.md): Change a card's status. For more information, Refer to the [Card lifecycle and statuses](doc:card-lifecycle-and-statuses) guide. This endpoint generates a [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event. - [Get card statuses](https://developers.pismo.io/pismo-docs/reference/get-v1-card-statuses.md): Get all possible card statuses, including those used for card reissuing. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [List card status history](https://developers.pismo.io/pismo-docs/reference/get-v1-card-satus-history.md): Gets a list of a card's status history. The IDs of the card's account and org/tenant are parsed from the access token. **Note**: * Only cards with status changes after September/2022 are returned. * This endpoint takes an account token - an access token encoded with a Pismo account ID. For more information, refer to [Card lifecycle and statuses](doc:card-lifecycle-and-statuses). - [Renew card validity](https://developers.pismo.io/pismo-docs/reference/patch-v2-card-validity-renew.md): Renew a card's validity period in hours. Renewal can be done for `VIRTUAL` cards and activated `PLASTIC` cards that were created or reissued with the `validity_period_hours` field set to a defined value greater than zero. When a card reaches its `valid_until` date, the card's status is set to `INOPERATIVE`. When this happens, a [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event is generated. For existing cards that never had `validity_period_hours` defined, you can do it through this endpoint. When the card is renewed: * A new `valid_until` date is calculated and a [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event is generated with `operation type` = `CARD_VALIDITY_RENEWAL`. * If the card's status is `INOPERATIVE`, the status changes to `NORMAL`. * If the card's status is `NORMAL`, `REISSUED`, `BLOCKED`, `PENDING` or `WARNING`, the status remains the same. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** error message. - [Delete card validity period](https://developers.pismo.io/pismo-docs/reference/delete-v2-card-validity.md): Delete a card's previously scheduled validity period. The card's validity period can be removed when a virtual or plastic card has a `valid_until` value in effect. If the card's status is `NORMAL`, `REISSUED`, `BLOCKED`, `PENDING`, or `WARNING`, the `valid_until` value is removed and the card's status remains the same. When authorizing a card with a `valid_until` value in effect, this date and the card's `expiration date` are both taken into account. Otherwise, only the `expiration_date` is taken into account. This endpoint generates a [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event with `operation_type` = `CARD_VALIDITY_CANCEL`. **Notes:** * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Change card password](https://developers.pismo.io/pismo-docs/reference/put-v2-card-password.md): Update a card's password (PIN). **Note**: This does not change the password recorded on an embossed card's chip. If the card is configured for offline password verification, you need to change the password on the physical card. To do that, you can use a [card script](doc:card-scripts). This endpoint generates a [Card password changed](https://developers.pismo.io/events/docs/cards-update-password-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Update PIN from PINblock](https://developers.pismo.io/pismo-docs/reference/put-v1-update-pin-from-pinblock.md): Update the card PIN (Personal Identification Number) from its PINBlock. PINlBocks are 64-bit strings that encode a PIN ready for encryption and secure transmission in banking networks. For more information, refer to the [PIN/PINBlock](doc:pinpinblock-tutorial) tutorial. **Note**: This does not change the password recorded on an embossed card's chip. If the card is configured for offline password verification, you need to change the password on the physical card. To do that, you can use a [card script](doc:card-scripts). This endpoint generates a [Card password changed](https://developers.pismo.io/events/docs/cards-update-password-1) event. **Notes:** * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get PIN as PINblock](https://developers.pismo.io/pismo-docs/reference/get-v1-pin-as-pinblock.md): Get the card PIN (Personal Identification Number) as a PINblock. PINblocks are 64-bit strings that encode a PIN ready for encryption and secure transmission in banking networks. For more information, refer to the [PIN/PINBlock](doc:pinpinblock-tutorial) tutorial. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get card info with encrypted PAN](https://developers.pismo.io/pismo-docs/reference/post-v2-card-search-by-pan.md): Get card information - card ID, account ID, customer ID - using a card's encrypted PAN (Primary Account Number). To set up encryption for this endpoint, contact your Pismo representative. Alternatively, to send the PAN as clear text, call the [Get card info with PAN](ref:post-v1-card-search-by-pan) endpoint. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get card info with PAN](https://developers.pismo.io/pismo-docs/reference/post-v1-card-search-by-pan.md): Get card info - account ID, customer ID and card ID - with the card's unencrypted PAN (Primary Account Number). If you are not comfortable passing a clear text PAN, you can call the [Get card info with encrypted PAN](ref:post-v2-card-search-by-pan) endpoint. Doing this requires you contact Pismo to set up encryption using public and private keys. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get card PCI information](https://developers.pismo.io/pismo-docs/reference/get-v2-card-info.md): Gets sensitive PCI (Payment Card Industry) card data. Calling this endpoint could change the status of `TEMPORARY` cards. For more information, refer to [Configuring temporary cards](https://developers.pismo.io/pismo-docs/docs/cards-overview-1#configuring-temporary-cards) in the [Cards management](https://developers.pismo.io/pismo-docs/docs/cards-overview-1) guide. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get card password](https://developers.pismo.io/pismo-docs/reference/get-v2-card-password.md): Gets card Personal Identification Number (PIN) used for authenticating purchases with Pinpads. **Notes:** * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Append update PIN script](https://developers.pismo.io/pismo-docs/reference/post-v1-append-update-pin-script.md): Append issuer script to update the card PIN that will be applied at the next authorization. You must work with Pismo to pre-register a script and get its script ID. For information on generating a PINBlock and key ID, refer to the [PIN/PINBlock tutorial](doc:pinpinblock-tutorial) guide. For more information, refer to the [Card scripts](doc:card-scripts) guide. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io/ environment. - [Append issuer script](https://developers.pismo.io/pismo-docs/reference/post-v1-append-scripts.md): Append issuer script to card that will be applied at the next authorization. You must work with Pismo to pre-register a script and get its script ID. For more information, refer to the [Card scripts](doc:card-scripts) guide. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Synchronize offline PIN](https://developers.pismo.io/pismo-docs/reference/post-v1-sync-offline-pin.md): Synchronize the offline PIN with the current online PIN value. The platform generates a script with the current online PIN, sends the script in response to the next authorization made with a chip (contact), and generates the [Card issuer script notification received](https://developers.pismo.io/events/docs/cards-issuer-script-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get card info with encrypted PAN V3 [beta]](https://developers.pismo.io/pismo-docs/reference/post-v2-card-search-by-pan-two.md): Get card information - card ID, account ID, customer ID - using a card's encrypted PAN (Primary Account Number). To set up encryption for this endpoint, contact your Pismo representative. Alternatively, to send the PAN as clear text, call the [Get card info with PAN](ref:post-v1-card-search-by-pan) endpoint. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Create noname card bulk](https://developers.pismo.io/pismo-docs/reference/create-bulk.md): Create up to 1000 noname cards per bulk/batch process. After calling this endpoint, call [Start noname card bulk process](ref:start-bulk) to begin the bulk/batch card creation and embossing process. Noname cards are batch-generated and not initially associated with customers, which occurs later. Noname cards work well for special use cases like gift cards or in countries or scenarios where a password or chip might be required but not necessarily a printed card name. One card is created for each `external_id` entered. For more information on embossing, refer to the [Physical card embossing](doc:physical-card-embossing) guide. For detailed information about embossing flows, refer to [Embossing flows](doc:physical-card-embossing#embossing-flows). - [Increment noname card bulk](https://developers.pismo.io/pismo-docs/reference/increment-bulk.md): Increment noname card bulk/batch with up to 1000 additional cards. Use the bulk ID returned from [Create noname card bulk](ref:create-bulk). One card is created for each `external_id` entered. - [Start noname card bulk process](https://developers.pismo.io/pismo-docs/reference/start-bulk.md): Start noname card bulk/batch process. Each card is identified with an `external_id`. This endpoint starts the process begun with [Create noname card bulk](ref:create-bulk). Pass the bulk ID returned from that endpoint here. Each card created generates an event - [Card created](https://developers.pismo.io/events/docs/cards-create-1) - with event data that includes the card ID, bulk ID, and external ID. You pass the card ID to the [Associate noname card with customer](ref:post-v2-card-bind) endpoint. For more information on events and setting up event notifications, rerfer to the [Data and reporting](doc:data-reporting-overview) guide. For more information on embossing, refer to the [Physical card embossing](doc:physical-card-embossing) guide. For detailed information about embossing flows, refer to [Embossing flows](doc:physical-card-embossing#embossing-flows). - [Associate noname card with customer](https://developers.pismo.io/pismo-docs/reference/post-v2-card-bind.md): Bind an account and customer to a noname card, which changes its status to `CREATED`. The card is then treated as a normal physical plastic or metal card. You have to pass this endpoint a noname card's ID. Card IDs are generated when the [Start noname card bulk process](ref:start-bulk) endpoint is called. This endpoint generates an event for each card - [Card created](https://developers.pismo.io/events/docs/cards-create-1) - with event data that includes the card ID, bulk ID, and external ID. Refer to the [Data and reporting](doc:data-reporting-overview) guide for information on events and setting up event notifications. The bind operation is completed asynchronously and generates a [Customer bound to noname card](https://developers.pismo.io/events/docs/cards-bind-card-1) event. Make sure the operation has completed and the event generated before attempting to access or use the associated card. **Card reissuing** * You can use this endpoint to reissue a card—replacing the card to be reissued with a noname card, which is then treated as a normal physical card. If a card to be replaced is entered (`reissued_card_id`), the [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event is also generated. * If you attempt to reissue a card to a card that has already been associated, meaning it is no longer a noname card and no longer has an `UNBOUND` status, you will get a **409 Conflict** error. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. - [Cancel noname bulk operation](https://developers.pismo.io/pismo-docs/reference/cancel-bulk.md): Cancel noname bulk operation. The canceling operation is executed asynchronously and generates a [Noname cancellation](https://developers.pismo.io/events/docs/cards-noname-cancellation-1) event when done. - [Validate noname card CVV](https://developers.pismo.io/pismo-docs/reference/post-v2-validate-card-cvv.md): Validates the given card's CVV. Only for cards that have not yet been [bound to an account and customer](ref:post-v2-card-bind). **Notes:** * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Start card embossing](https://developers.pismo.io/pismo-docs/reference/start-embossing.md): Starts card embossing for a specific embossing configuration. Within that configuration, you can emboss cards for a specific program or card(s). * If only `config_id` is passed in the request, then all cards in all programs are added to the embossing file. * If `config_id` and program ID(s) are passed in the request, then all cards in those programs are added to the embossing file. * If `config_id` and card ID(s) are passed in the request, then only those cards are added to the embossing file. You can call the [List embossing files](ref:get-embossing-file-info) endpoint to get embossing configuration IDs. The file generation is asynchronous and not in real-time for any option described above. Only available in the EXT environment. For more information, refer to [Embossing flows](doc:physical-card-embossing#embossing-flow). **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Update nominal card embossing group](https://developers.pismo.io/pismo-docs/reference/patch-embossing-group.md): Update a nominal card's embossing group.
As a card issuer, you can set up your own embossing configuration in the Pismo platform, which can have multiple embossing groups. Each embossing group can have its own configured schedule and embosser. Assigning a card to a different embossing group effectively changes its schedule and embosser. Contact your Pismo representative to set up your embossing configuration and process. For more information on embossing, refer to the [Physical card embossing](doc:physical-card-embossing) guide. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Update noname card embossing group](https://developers.pismo.io/pismo-docs/reference/patch-noname-embossing-group.md): Update the embossing group for noname cards.
Noname cards are batch-generated and not initially associated with customers, which occurs later. As a card issuer, you can set up your own embossing configuration in the Pismo platform, which can have multiple embossing groups. Each embossing group can have its own configured schedule and embosser. Assigning a card to a different embossing group effectively changes its schedule and embosser. Contact your Pismo representative to set up your embossing configuration and process. For more information on embossing, refer to the [Physical card embossing](doc:physical-card-embossing) guide. **Notes:** * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Update card embossing address](https://developers.pismo.io/pismo-docs/reference/patch-embossing-address.md): Updates the embossing address. Currently, the embossing process uses the address of the customer linked to the account. However, you can use this endpoint to send the embossed card to an address other than the mailing address. For example, a customer is traveling and loses their card. They request a duplicate and want it delivered to their hotel. With this endpoint, it is possible to have it sent to another address without changing their default mailing address. You can call the [Create new address](ref:post-accounts-v1-accounts-accountid-addresses) endpoint to create an address object and get an address ID. For more information about embossing, refer to the [Physical card embossing](doc:physical-card-embossing) guide. **Notes:** * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Add card to next scheduled embossing](https://developers.pismo.io/pismo-docs/reference/put-cards-embossing.md): Add card to next scheduled embossing. You can use this endpoint for On Demand embossing. For more information, refer to [Embossing rules](doc:physical-card-embossing#embossing-rules) > On Demand embossing and [Embossing flows](doc:physical-card-embossing#embossing-flow). **IMPORTANT**: * You should only call this endpoint **AFTER** the [Card can be added to next scheduled embossing](https://developers.pismo.io/events/docs/cards-embossing-card-ingress-1) event is received. This event is generated when a card is created and all necessary asynchronous PCI configuration is done. * This endpoint does **NOT** generate an event. **Notes:** * To use this endpoint, request it with a [Jira ticket](doc:opening-a-service-desk-ticket) with type = Settings and ask to use *ondemand* embossing. * If you call this endpoint, the [Change card password](ref:put-v2-card-password) endpoint will no longer add the card for embossing. * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Delete card from next scheduled embossing](https://developers.pismo.io/pismo-docs/reference/delete-cards-embossing.md): Delete card from next scheduled embossing. This endpoint only works in conjunction with the [Add card to next scheduled embossing](ref:put-cards-embossing) endpoint. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Resend cards for embossing](https://developers.pismo.io/pismo-docs/reference/start-reembossing.md): Enables cards to be sent again to the embosser at the next scheduled time. Cards to be resent must meet the prerequisites. For more information, refer to the [Physical card embossing guide](doc:physical-card-embossing). This endpoint is available to on-demand customers. On-demand customers can emboss cards with `NORMAL`, `BLOCKED`, `PENDING`, and `WARNING` statuses, in addition to `CREATED`. This endpoint generates a [Card reembossing notification received](https://developers.pismo.io/events/docs/cards-reembossing-1) event. **Notes:** * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get nominal card embossing info](https://developers.pismo.io/pismo-docs/reference/get-embossing-info.md): Get nominal card embossing information.
For more information on embossing, refer to the [Physical card embossing](doc:physical-card-embossing) guide. **Notes:** * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. * This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** error message. - [Get noname card embossing info](https://developers.pismo.io/pismo-docs/reference/get-noname-embossing-info.md): Get noname card embossing group information. Noname cards are batch-generated and not initially associated with customers, which occurs later. Contact your Pismo representative to set up your embossing configuration and process. For more information on embossing, refer to the [Physical card embossing](doc:physical-card-embossing) guide. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [List embossing files info](https://developers.pismo.io/pismo-docs/reference/get-embossing-file-info.md): List embossing file information with date, program, and configuration filters. For more information about embossing, refer to the [Physical card embossing](doc:physical-card-embossing) guide. For detailed information about embossing flows, refer to [Embossing flows](doc:physical-card-embossing#embossing-flows). **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get embossing file](https://developers.pismo.io/pismo-docs/reference/get-embossing-download-file.md): Download embossing file sent from Pismo to an embosser. Only available in the EXT environment. You can call the [List embossing files info](ref:get-embossing-file-info) endpoint to get embossing file names and configuration IDs. Embossing file names are also available via two events: [Card embossing notification received](https://developers.pismo.io/events/docs/cards-embossing-1) (`tracking` field) and the [Embossing summary received](https://developers.pismo.io/events/docs/cards-embossing-summary-1) event (`file-name` field). For more information about embossing, refer to the [Physical card embossing](doc:physical-card-embossing) guide. For detailed information about embossing flows, refer to [Embossing flows](doc:physical-card-embossing#embossing-flows). **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get org embosser info](https://developers.pismo.io/pismo-docs/reference/get-embossing-configurations-info.md): Get detailed information about an organization's embossing configurations. The organization/tenant ID is derived from the access token. For more information about embossing, refer to the [Physical card embossing](doc:physical-card-embossing) guide. For detailed information about embossing flows, refer to [Embossing flows](doc:physical-card-embossing#embossing-flows). **Notes:** * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get card embossing history](https://developers.pismo.io/pismo-docs/reference/get-embossing-history.md): Retrieve a card's embossing history information. **Notes:** * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get nominal encrypted card data for embossing](https://developers.pismo.io/pismo-docs/reference/post-generate-embossing.md): Get encrypted card embossing data. This is for issuers doing their own embossing and require a card's data, which needs to be encrypted as per regulations. **To use this endpoint:** * Open a [Jira ticket](https://developers.pismo.io/pismo-docs/docs/opening-a-service-desk-ticket) with type = **Settings** and ask to use on-demand embossing. * Generate and register a symmetric key with Pismo: open a Jira ticket with type = **Settings** and request an asymmetric key (RSA 2048 PKCS1) to send the symmetric key. While the return values are shown as JSON, they are encrypted and not returned as clear text. The endpoint generates a [Card embossing notification received](https://developers.pismo.io/events/docs/cards-embossing-1) event. **Notes:** * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get nominal encrypted card data for embossing V2 [beta]](https://developers.pismo.io/pismo-docs/reference/post-generate-embossing-no-iv.md): Get encrypted card embossing data. Issuers who do their own embossing can use this endpoint to get a card's data, which needs to be encrypted as per regulations. This endpoint uses AES256 with the GCM mode, and randomly generates the initialization vector, returning it in the response. AES-256 GCM is an authenticated encryption mode that uses the Advanced Encryption Standard (AES) with a 256-bit key in Galois/Counter Mode (GCM) to provide both confidentiality and integrity for data. The Additional Authenticated Data (AAD) parameter used is the organization/tenant ID. AAD, in AES-GCM, is unencrypted data that is authenticated alongside the ciphertext to ensure the message's integrity and authenticity. **To use this endpoint:** * Open a [Jira ticket](https://developers.pismo.io/pismo-docs/docs/opening-a-service-desk-ticket) with type = **Settings** and ask to use on-demand embossing. * Generate and register a symmetric key with Pismo: open a Jira ticket with type = **Settings** and request an asymmetric key (RSA 2048 PKCS1) to send the symmetric key. While the return values are shown as JSON, they are encrypted and not returned as clear text. The endpoint generates a [Card embossing notification received](https://developers.pismo.io/events/docs/cards-embossing-1) event. **Notes:** * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get noname encrypted card data for embossing [beta]](https://developers.pismo.io/pismo-docs/reference/post-generate-embossing-encrypted-noname.md): Get noname encrypted card embossing data. This is for issuers doing their own embossing and require a card's data, which needs to be encrypted as per regulations. **To use this endpoint:** * Open a [Jira ticket](https://developers.pismo.io/pismo-docs/docs/opening-a-service-desk-ticket) with type = **Settings** and ask to use on-demand embossing. * Generate and register a symmetric key with Pismo: open a Jira ticket with type = **Settings** and request an asymmetric key (RSA 2048 PKCS1) to send the symmetric key. While the return values are shown as JSON, they are encrypted and not returned as clear text. The endpoint generates a [Card embossing notification received](https://developers.pismo.io/events/docs/cards-embossing-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get noname encrypted card data for embossing V2 [beta]](https://developers.pismo.io/pismo-docs/reference/post-generate-embossing-noname.md): Get noname encrypted card embossing data. Issuers who do their own embossing can use this endpoint to get a card's data, which needs to be encrypted as per regulations. This endpoint uses AES256 with the GCM mode, and randomly generates the initialization vector, returning it in the response. AES-256 GCM is an authenticated encryption mode that uses the Advanced Encryption Standard (AES) with a 256-bit key in Galois/Counter Mode (GCM) to provide both confidentiality and integrity for data. The Additional Authenticated Data (AAD) parameter used is the organization/tenant ID. AAD, in AES-GCM, is unencrypted data that is authenticated alongside the ciphertext to ensure the message's integrity and authenticity. **To use this endpoint:** * Open a [Jira ticket](https://developers.pismo.io/pismo-docs/docs/opening-a-service-desk-ticket) with type = **Settings** and ask to use on-demand embossing. * Generate and register a symmetric key with Pismo: open a Jira ticket with type = **Settings** and request an asymmetric key (RSA 2048 PKCS1) to send the symmetric key. While the return values are shown as JSON, they are encrypted and not returned as clear text. The endpoint generates a [Card embossing notification received](https://developers.pismo.io/events/docs/cards-embossing-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Add card mode](https://developers.pismo.io/pismo-docs/reference/post-v1-card-mode.md): Add mode to specified card to make it a combination card. A card can have both a credit and debit *mode*, meaning it can be used as both a credit or debit card. Each mode is associated with a credit or debit program and account. The mode and program/account to be added is derived from the access token which **must** be an account-specific access token. For more information, refer to the [mode documentation](doc:cards-overview-1#create-a-combination-card-with-card-modes) in the Cards overview guide. - [Get card modes](https://developers.pismo.io/pismo-docs/reference/get-v1-card-mode.md): Get card mode objects. A card can have both a credit and debit *mode*, meaning it can be used as both a credit or debit card. Each mode is associated with a credit or debit program and account. For more information, refer to the [mode documentation](doc:cards-overview-1#create-a-combination-card-with-card-modes) in the Cards overview guide. NOTE: This endpoint requires an account-specific access token - a token encoded with a Pismo account ID. - [Change card mode status](https://developers.pismo.io/pismo-docs/reference/put-v1-card-mode-status.md): Change card mode status (active or suspended). A card can have both a credit and debit *mode*, meaning it can have both a credit and debit account. Each mode is associated with a credit or debit program and account. For more information, refer to the [mode documentation](doc:cards-overview-1#create-a-combination-card-with-card-modes) in the Cards overview guide. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Get card template](https://developers.pismo.io/pismo-docs/reference/get-card-template-by-id.md): Get card template. Templates are used to overwrite program card BIN defaults. To create a template, you need to open a Pismo [Service Desk](doc:service-desk) request. The ticket type should be **Settings**. For more information, refer to the [BIN override](doc:bin-override-feature) guide. - [List card templates](https://developers.pismo.io/pismo-docs/reference/get-card-templates.md): Gets the BIN data for an organization's card templates with paging options. For complete information on a specific template, call the [Get card template](ref:get-card-template-by-id) endpoint. The organization is identified in the access token. To create a template, you need to open a Pismo [Service Desk](doc:service-desk) request. The ticket type should be **Settings**. For more information, refer to the [BIN override](doc:bin-override-feature) guide. - [Update nominal card PAN/PIN [beta]](https://developers.pismo.io/pismo-docs/reference/put-v1-update-pan-nominal.md): Update a nominal `UNNUMBERED` card's Primary Account Number (PAN) and, optionally, Personal Identification Number (PIN). `UNNUMBERED` cards are created without a Pismo platform-generated PAN and PIN. **Notes:** * To set up encryption for this endpoint, contact your Pismo representative. * This endpoint takes an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. * This endpoint generates a [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event with `operation_type` = `PAN_UPDATE`. For more information, refer to [Issuer-defined PAN/PIN](https://developers.pismo.io/pismo-docs/docs/cards-overview-1#issuer-defined-panpin). - [Update noname card PAN/PIN [beta]](https://developers.pismo.io/pismo-docs/reference/put-v1-update-pan-noname.md): Update a noname `UNNUMBERED` card's Primary Account Number (PAN) and, optionally, Personal Identification Number (PIN). `UNNUMBERED` cards are created without a Pismo platform-generated PAN and PIN. To set up encryption for this endpoint, contact your Pismo representative. This endpoint generates a [Card updated](https://developers.pismo.io/events/docs/cards-update-1) event with `operation_type` = `PAN_UPDATE`. For more information, refer to [Issuer-defnined PAN/PIN](doc:cards-overview-1#issuer-defined-panpin). - [Migrate card to different program [beta]](https://developers.pismo.io/pismo-docs/reference/patch-migrate-card.md): Migrate a card to a different program. It is possible to migrate from a Zero balance program to a Full balance program and vice-versa. This endpoint generates two events: * [Card can be added to next scheduled embossing](https://developers.pismo.io/events/docs/cards-embossing-card-ingress-1) event containing the field `operation_type` = `CARD_PROGRAM_MIGRATION` if the card has not yet been embossed. * [Card migrated](https://developers.pismo.io/events/docs/cards-migration-1) event. **Notes:** * This endpoint **REQUIRES** an account token - an access token encoded with a Pismo account ID. * For combination cards, this endpoint migrates the [card mode](doc:cards-overview-1#create-a-combination-card-with-card-modes) the card was originally created with. To migrate the secondary mode, call the [Migrate card mode](ref:patch-migrate-card-mode) endpoint. - [Migrate card mode [beta]](https://developers.pismo.io/pismo-docs/reference/patch-migrate-card-mode.md): Migrate a [card's mode](doc:cards-overview-1#create-a-combination-card-with-card-modes) to a different program. Migrate a card's secondary mode (debit or credit) to a new program. If a combination card is initially created with a credit account (has a `CREDIT` mode), it gets migrated when the [Migrate card to different program](ref:patch-migrate-card) endpoint is called. However, if you wish to migrate the debit (secondary) mode, you need to call this endpoint. This endpoint generates a [Card migrated](https://developers.pismo.io/events/docs/cards-migration-1) event. **Note:** This endpoint **REQUIRES** an account token - an access token encoded with a Pismo account ID. - [Assign card segment](https://developers.pismo.io/pismo-docs/reference/post-v1-benefits-segments-assign.md): Assigns segment to a card. An array of bundles are then assigned to the card. A Mastercard card **segment** is a specific cardholder grouping (e.g., premium, business, or travel-focused) that issuers use to allocate tailored benefit bundles such as travel insurance, concierge services, or concierge access to particular cards. These segments allow for personalized, dynamic, and targeted rewards assigned to cardholders via API. A Mastercard card segment **bundle** is a targeted package of benefits, rewards, or services assigned to specific carholder groups based on need. This endpoint generates a [Cards benefits allocation updated](https://developers.pismo.io/events/docs/cards-benefits-allocation-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Replace card segment and benefits](https://developers.pismo.io/pismo-docs/reference/post-v1-benefits-segments-replace.md): Replaces the segment and existing benefits with a new benefit set assigned via a new segment code. The existing benefits are cancelled, and new benefits are assigned. An array of newly-assigned bundles is returned in the response. This endpoint generates a [Cards benefits allocation updated](https://developers.pismo.io/events/docs/cards-benefits-allocation-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Cancel card segment and benefits](https://developers.pismo.io/pismo-docs/reference/post-v1-benefits-segments-cancel.md): Cancels a segment and the benefits associated to the card for the input segment. The canceled bundle array is returned. Exactly one input segment is supported at this time. It is defined as an array for future support. This endpoint generates a [Cards benefits allocation updated](https://developers.pismo.io/events/docs/cards-benefits-allocation-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Replace user card number](https://developers.pismo.io/pismo-docs/reference/post-v1-benefits-cards-cancel.md): Replaces user card number associated. The old card benefits are cancelled, and the same benefit set is applied to the new card. This endpoint generates a [Cards benefits allocation updated](https://developers.pismo.io/events/docs/cards-benefits-allocation-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Allow freezing/unfreezing card benefits](https://developers.pismo.io/pismo-docs/reference/post-v1-benefits-cards-freeze.md): Allows freezing or unfreezing a card for benefits. This endpoint generates a [Cards benefits allocation updated](https://developers.pismo.io/events/docs/cards-benefits-allocation-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Rotate virtual card CVV](https://developers.pismo.io/pismo-docs/reference/post-v2-reset-cvv.md): Force a virtual card's CVV (Card Verification Value) rotation. **CVV rotation rules:** Calling this endpoint can reset the CVV rotation schedule in the future. For example, if you call this endpoint at 3PM and the defined rotation interval is 24 hours, the next rotation will take place at 3PM the next day and subsequent days after. A 2-minute validation occurs between scheduling requests and, within this interval, no new scheduling takes place. This can lead to the following scenarios: * If a forced rotation occurs less than 2 minutes after an auto-rotation, the CVV is rotated and no new scheduling takes place. * If an auto-rotation occurs less than 2 minutes after a forced rotation, the CVV is rotated and no new scheduling takes place. * If more than one forced call occurs in less than 2 minutes, the CVV is rotated, but new scheduling only takes place for the first call. This endpoint generates a [Card CVV changed](https://developers.pismo.io/events/docs/cards-rotate-cvv-1) event. **Note:** This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Update CVV rotation interval](https://developers.pismo.io/pismo-docs/reference/patch-v2-card-change-rotation.md): Allows to manage CVV rotation, for example: * Set CVV rotation for cards without CVV rotation * Increase/decrease CVV rotation interval A [Card CVV changed](https://developers.pismo.io/events/docs/cards-rotate-cvv-1) event is generated with `operation_type` = `CHANGE_CVV_ROTATION` **Notes** * This endpoint takes an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Delete CVV card rotation interval](https://developers.pismo.io/pismo-docs/reference/delete-v2-card-delete-rotation.md): Deletes CVV rotation for cards with active rotation. A [Card CVV changed](https://developers.pismo.io/events/docs/cards-rotate-cvv-1) event is generated with `operation_type` = `DELETE_CVV_ROTATION`. **Notes** * This endpoint takes an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Automatic updater opt-out](https://developers.pismo.io/pismo-docs/reference/post-vau-opt-out.md): Opt out of Visa Automatic Updater (VAU) or Mastercard's Automatic Billing Updater (ABU). This entry is processed during the next file generation window and be sent to the network. This endpoint generates an [Automatic Updater notification file sent](https://developers.pismo.io/events/docs/cards-automatic-updater-1) event. For more information, refer to the [Automatic updater](doc:automatic-updater) guide. - [Visa automatic updater opt-in](https://developers.pismo.io/pismo-docs/reference/post-vau-opt-in.md): Opt a card in to Visa Automatic Updater (VAU). This entry is processed during the next file generation window and be sent to the network. This endpoint generates an [Automatic Updater notification file sent](https://developers.pismo.io/events/docs/cards-automatic-updater-1) event. For more information, refer to the [Automatic updater](doc:automatic-updater) guide. - [Create authorization configuration by organization](https://developers.pismo.io/pismo-docs/reference/post-authorization-config-by-tenant.md): Create an authorization configuration for an authorization at the organization (org) level. This level can be used as a default configuration for all programs and accounts in this org. An org can only have one configuration. Executing this endpoint on an org that already has a configuration defined for it generates a conflict response. - [Get authorization configuration by organization](https://developers.pismo.io/pismo-docs/reference/get-authorization-config-by-tenant.md): Get the authorization configuration at the org level. - [Update authorization configuration by organization](https://developers.pismo.io/pismo-docs/reference/putauthorizationconfigbytenant.md): Update the authorization configuration at the organization (org) level. This operation updates the entire configuration. Therefore, all fields must be sent to avoid data loss. - [Delete authorization configuration by organization](https://developers.pismo.io/pismo-docs/reference/deleteauthorizationconfigbytenant.md): Delete an authorization configuration for an authorization at the organization (org) level. This level can be used as a default configuration for all programs and accounts in this org. - [Create authorization configuration by program](https://developers.pismo.io/pismo-docs/reference/postauthorizationconfigbyprogram.md): Create the authorization configuration at the program level. This level can be used as a default configuration for all accounts in this program and at a more granular level than org. A program can only have one configuration. Executing this endpoint on a program that already has a configuration defined for it generates a conflict response. - [Get authorization configuration by program](https://developers.pismo.io/pismo-docs/reference/getauthorizationconfigbyprogram.md): Get the authorization configuration at the program level. - [Update authorization configuration by program](https://developers.pismo.io/pismo-docs/reference/putauthorizationconfigbyprogram.md): Update the authorization configuration at the program level. This operation updates the entire configuration. Therefore, all fields must be sent to avoid data loss. - [Delete authorization configuration by program](https://developers.pismo.io/pismo-docs/reference/deleteauthorizationconfigbyprogram.md): Delete the authorization configuration at the program level. This level can be used as a default configuration for all accounts in this program and at a more granular level than org. - [Create authorization configuration by account](https://developers.pismo.io/pismo-docs/reference/postauthorizationconfigbyaccount.md): Create the authorization configuration at the account level. This is the most granular level allowed and can be used to customize a specific account. An account can only have one configuration. Executing this endpoint on an account that already has a configuration defined for it generates a conflict response. - [Get authorization configuration by account](https://developers.pismo.io/pismo-docs/reference/getauthorizationconfigbyaccount.md): Get the authorization configuration at the account level. - [Update authorization configuration by account](https://developers.pismo.io/pismo-docs/reference/putauthorizationconfigbyaccount.md): Update the authorization configuration at the account level. This operation updates the entire configuration. Therefore, all fields must be sent to avoid data loss. - [Delete authorization configuration by account](https://developers.pismo.io/pismo-docs/reference/deleteauthorizationconfigbyaccount.md): Delete the authorization configuration at the account level. This is the most granular level allowed and can be used to customize a specific account. - [Get authorization configuration by hierarchy](https://developers.pismo.io/pismo-docs/reference/getauthorizationconfigbypriority.md): Retrieve the authorization configuration based on the hierarchy: account -> program -> tenant, in other words from the most granular to the less granular one. - [Send pre-authentication for evaluation](https://developers.pismo.io/pismo-docs/reference/postevaluate.md): Send pre authentication information to customer to evaluate the authentication. - [Send challenge information](https://developers.pismo.io/pismo-docs/reference/postchallengerequest.md): Send pre-authentication information to customer for challenge. - [Get challenge result](https://developers.pismo.io/pismo-docs/reference/postchallengeresult.md): Receive challenge result. - [Send pre-authentication info](https://developers.pismo.io/pismo-docs/reference/postpreauthenticate.md): Send pre-authentication information to the client's anti-fraud validator to evaluate. Pismo calls the validator's webhook and gets a response before sending a response to the caller. Pismo provides the encrypt/decrypt keys for the hashed PAN. Talk to your Pismo representative about getting these keys. For information on PAN encryption, refer to the [PAN encryption for 3DS authentication](doc:pan-encryption-for-3ds-authentication) guide. - [Issuer’s endpoint to handle VCAS stepup flow](https://developers.pismo.io/pismo-docs/reference/poststepup.md): Informs VCAS which authentication types are available for a specific user. - [Issuer’s endpoint to handle VCAs initiate action flow](https://developers.pismo.io/pismo-docs/reference/postinitiateaction.md): Informs the issuer about the initiate action flow in the VCAS process. - [Issuer’s endpoint to handle VCAs validate flow](https://developers.pismo.io/pismo-docs/reference/postvalidation.md): Informs the issuer about the validation flow. - [Assign network card profile](https://developers.pismo.io/pismo-docs/reference/post-v1-cards-card-id-network-tokens-profile.md): Binds a network card profile to specified card. Pass the network profile identifier as a string. The network card profile determines such things as how the card is visually displayed in a mobile payment app. As the issuer, you need to configure network profiles with the card network. **Notes**: * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Get network card profile](https://developers.pismo.io/pismo-docs/reference/get-v1-cards-card-id-network-tokens-profile.md): Gets the card's associated network card profile identifier. **Notes**: * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Update network card profile](https://developers.pismo.io/pismo-docs/reference/put-v1-cards-card-id-network-tokens-profile.md): Update an existing network card profile with a different one. This affects the display at the next tokenization (after deleting the token and creating another one). **Notes**: * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Create encrypted card data for Google Pay](https://developers.pismo.io/pismo-docs/reference/post-wallet-data.md): Get encrypted card data to provision a token via Goodle SDK push-provisioning. Also returned is cardholder identifying information. **Notes**: * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Create encrypted card data for Samsung Pay](https://developers.pismo.io/pismo-docs/reference/post-wallet-data-samsung.md): Get encrypted card data to provision a token via Samsung SDK push-provisioning. Also returned is cardholder identifying information. **Notes**: * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID. * Currently only available for Visa - [Create encrypted card data for Apple Pay](https://developers.pismo.io/pismo-docs/reference/post-encrypted-applepay-data.md): Generate encrypted card data to provision a token via push-provisioning and the Apple SDK. Also returned is cardholder identifying information. **Notes:** * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Perform token operation](https://developers.pismo.io/pismo-docs/reference/performtokenop.md): Perform token operation. **Notes**: * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID - [Get token information](https://developers.pismo.io/pismo-docs/reference/gettokeninfo.md): Gets token information given a card ID and token ID in the path. **Notes**: * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Bind Visa device and token](https://developers.pismo.io/pismo-docs/reference/post-run-visa-device-lifecycle.md): Executes Visa device binding for a given token and device. Device binding establishes that a specific device belongs to a specific cardholder. Once bound, the device can be trusted more in future transactions. An issuer can use this endpoint to update the status of a specific device linked to a token. **Notes**: * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID - [Transfer card tokens to other card](https://developers.pismo.io/pismo-docs/reference/transfertokens.md): Transfer all active tokens (activated/suspended) from one card to another This endpoint generates a [PAN updated](https://developers.pismo.io/events/docs/cards-tokenization-pan-update-1) event. **Notes**: * This endpoint requires an account token - an access token encoded with a Pismo account ID. * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. - [Get card tokens](https://developers.pismo.io/pismo-docs/reference/get-card-token-info.md): Gets token information given a card ID in the path. **Notes**: * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID. - [Card token operation](https://developers.pismo.io/pismo-docs/reference/card-token-operation.md): Perform token operation for card identified in path. - [Get card configuration](https://developers.pismo.io/pismo-docs/reference/get-card-config.md): Get card configuration. **Notes**: * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID - [Reset CVV2 retry counter](https://developers.pismo.io/pismo-docs/reference/patch-card-config-reset-cvv2-try-counter.md): Reset card and wallet CVV2 try counter to zero. **Notes**: * This is a PCI endpoint, use the https://gw-pci.pismolabs.io/cards-tokenization environment. * This endpoint takes an account token - an access token encoded with a Pismo account ID - [Enroll customer and card in Visa CTP](https://developers.pismo.io/pismo-docs/reference/post-v1-clicktopay-enroll_customer.md): Enroll a customer and card in Visa's Click to Pay service. Click to Pay is a secure, streamlined online checkout solution using tokenization. For more information, refer to [Click to Pay](doc:click-to-pay). This endpoint generates a [Click to Pay event generated](https://developers.pismo.io/events/docs/cards-tokenization-click-to-pay-1) event. **Notes**: - The following fields are **mandatory** to enroll a customer/card into Visa's Click to Pay: `first_name`, `last_name`, `emails`, `phones` and `billing_address`. If not passed and not found internally, an error is returned. - The process is asynchronous, success or failure is indicated in the generated event. - This endpoint takes an account token - an access token encoded with a Pismo account ID. - This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Enroll card in Visa CTP](https://developers.pismo.io/pismo-docs/reference/post-v1-clicktopay-enroll_card.md): Enroll a customer card in Visa Click to Pay. This endpoint generates a [Click to Pay event generated](https://developers.pismo.io/events/docs/cards-tokenization-click-to-pay-1) event. **Notes**: - If `billing_address` is not passed, it is looked for internally. If not found, an error is returned. - This endpoint takes an account token - an access token encoded with a Pismo account ID. - The process is asynchronous, success or failure is indicated in the generated event. - This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get Visa CTP customer cards status](https://developers.pismo.io/pismo-docs/reference/post-v1-clicktopay-get_data.md): Returns customer's cards statuses (active or inactive) in the Visa Click to Pay service. **Notes**: - This endpoint takes an account token - an access token encoded with a Pismo account ID. - This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Update Visa CTP customer](https://developers.pismo.io/pismo-docs/reference/post-v1-clicktopay-manage_customer.md): Update customer data in the Visa Click to Pay service. This endpoint generates a [Click to Pay event generated](https://developers.pismo.io/events/docs/cards-tokenization-click-to-pay-1) event. **Notes**: - Any field not passed is not updated. - This endpoint takes an account token - an access token encoded with a Pismo account ID. - The process is asynchronous, success or failure is indicated in the generated event. - This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Update Visa CTP customer billing address](https://developers.pismo.io/pismo-docs/reference/put-v1-clicktopay-manage_card.md): Update the billing address for customer cards in Visa Click to Pay. This endpoint generates a [Click to Pay event generated](https://developers.pismo.io/events/docs/cards-tokenization-click-to-pay-1) event. **Notes**: - If billing address information is not passed, it is looked for internally. If not found, an error is returned. - The process is asynchronous, success or failure is indicated in the generated event. - This endpoint takes an account token - an access token encoded with a Pismo account ID. - This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Delete Visa CTP customer](https://developers.pismo.io/pismo-docs/reference/post-v1-clicktopay-delete_customer.md): Delete the customer and all their cards from the Visa Click to Pay service, This endpoint generates a [Click to Pay event generated](https://developers.pismo.io/events/docs/cards-tokenization-click-to-pay-1) event. **Notes**: - This endpoint takes an account token - an access token encoded with a Pismo account ID. - The process is asynchronous, success or failure is indicated in the generated event. - This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Delete Visa CTP card](https://developers.pismo.io/pismo-docs/reference/post-v1-clicktopay-delete_card.md): Remove a customer's card from Visa Click to Pay service. This endpoint generates a [Click to Pay event generated](https://developers.pismo.io/events/docs/cards-tokenization-click-to-pay-1) event. **Notes**: - This endpoint takes an account token - an access token encoded with a Pismo account ID. - The process is asynchronous, success or failure is indicated in the generated event. - This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Push multiple accounts](https://developers.pismo.io/pismo-docs/reference/token_connet_push_multiple_accounts.md): Push card and account(s) to a token requestor. A token requestor is an entity that initiates the tokenization process. Wallets, merchants, payments service providers (PSPs) are collectively referred to as **token requestors**. **Notes:** * Pismo acts as a proxy for the Mastercard Token Connect API * This endpoint does not generate an event * For more information, refer to the [MDES Token Connect](doc:mdes-token-connect) guide. - [Get eligible token requestors](https://developers.pismo.io/pismo-docs/reference/token_connect_get_eligible_token_requestors.md): Retrieve information about token requestors that have been enabled for one or more of the issuer's account ranges. Pismo acts as a proxy for the Mastercard Token Connect API For more information, refer to the [MDES Token Connect](doc:mdes-token-connect) guide. - [Get token requestor logo](https://developers.pismo.io/pismo-docs/reference/token_connect_get_asset.md): Returns a token requestor's logo, in `PNG` and `SVG` format. For more information, refer to the Mastercard Token Connect API. Pismo acts as a proxy for the Mastercard Token Connect API. For more information, refer to the [MDES Token Connect](doc:mdes-token-connect) guide. - [Create dispute](https://developers.pismo.io/pismo-docs/reference/post-v1-networkauthorization-disputes.md): Create a dispute for a Zero or Full balance program. You can create a dispute for a transaction made with a Pismo-issued card (Full balance) or with another card (Zero balance). You need to pass different parameters depending on which one as noted in the parameter descriptions. Disputes are initially created with a `PENDING` status. After you've uploaded all your supporting forms and evidence files, call [Update dispute status](https://developers.pismo.io/pismo-docs/reference/post-v1-disputes-disputeid-event) and use the `OPEN` event to change the status to `OPENED` and begin the dispute process with the network. For more information on events and statuses, refer to the Disputes state machine. This endpoint generates a Dispute installment created event. **Note:** For Zero balance customers, this endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. - [List disputes](https://developers.pismo.io/pismo-docs/reference/get-v1-disputes.md): Get disputes with paging and filter options. - [Get dispute](https://developers.pismo.io/pismo-docs/reference/get-v1-disputes-disputeid.md): Get information about a specific dispute given its ID in the path. You can use the [List disputes](ref:get-v1-disputes) endpoint to get dispute IDs. - [Update dispute](https://developers.pismo.io/pismo-docs/reference/put-v1-disputes-disputeid.md): Update one or more dispute fields. Parameters that are not passed are not updated. **Note:** You can only update a dispute if its group status is `OPEN`, `FAILED`, `DENIED` or `MIGRATION`. Refer to the [Dispute state machine](https://developers.pismo.io/pismo-docs/docs/disputes-state-machine) for more information. - [Update dispute status](https://developers.pismo.io/pismo-docs/reference/post-v1-disputes-disputeid-event.md): Change a dispute's status via an event. After creating a dispute and uploading all necessary forms, reports, and evidence files, send the event `OPEN` to officially begin the dispute process with the network. For more information on events and statuses, refer to the Disputes state machine. This endpoint generates a [Dispute status changed](https://developers.pismo.io/events/docs/disputes-dispute-installment-status-change-1) event. - [Count disputes per group status](https://developers.pismo.io/pismo-docs/reference/get-v1-disputes-count.md): Count disputes aggregated by group status. - [Acknowledge dispute](https://developers.pismo.io/pismo-docs/reference/post-v1-disputes-acknowledge.md): Mark a processed installment. This feature is only available for Mastercard. - [Close dispute](https://developers.pismo.io/pismo-docs/reference/post-v1-disputes-close.md): Close a dispute. This feature is only available for Mastercard. - [Network chargeback reversal](https://developers.pismo.io/pismo-docs/reference/network-reversal.md): Cancel a chargeback. You can use this endpoint to cancel a chargeback if you realize it is in error. Note: You can reverse a chargeback after the Global Clearing Management System has processed it. - [Create dispute installment](https://developers.pismo.io/pismo-docs/reference/post-v1-disputes-disputeid-installment.md): Create a dispute installment for transactions with multiple Installments. This endpoint generates a [Dispute installment created](https://developers.pismo.io/events/docs/disputes-dispute-installment-creation-1) event. - [Get dispute installment](https://developers.pismo.io/pismo-docs/reference/get-v1-disputes-installment.md): Get a dispute installment - [Upload evidence file](https://developers.pismo.io/pismo-docs/reference/post-v1-disputes-disputeid-file.md): Upload a file for the dispute process. - [Get dispute files](https://developers.pismo.io/pismo-docs/reference/get-v1-disputes-disputeid-files.md): Get files related to a specific dispute. - [Download dispute file](https://developers.pismo.io/pismo-docs/reference/get-v1-disputes-disputeid-files-fileid.md): Download an uploaded dispute file - [Create dispute form](https://developers.pismo.io/pismo-docs/reference/post-v1-disputes-disputeid-forms.md): Create a dispute form with more information to send to the network. You can create one of the following types of Expedited Billing Dispute Forms (EBDF): 1. **fraudDrfDocument** - Used for cases of fraud 2. **cardholderDisputeChargebackDrfDocument** - Used when the cardholder disputes a purchase and notifies the card issuer. 3. **pointOfInteractionErrorsDrfDocument** - Used when there's either a disagreement between parties or an error with the transaction. For example, a wrong value or a duplicate charge. For VISA, you need to fill out the `allocationQuestionnaire` (reason 11) or `collaborationQuestionnaire` (reason 12 and 13) form object. VISA's rules for filling out form fields can be found in [this guide document](https://developers.pismo.io/pismo-docs/docs/visa-colloboration-questionaire) For Elo, you need to fill out the `clearingElo` form object. - [Update dispute form](https://developers.pismo.io/pismo-docs/reference/put-v1-disputeform-forms.md): Update a dispute form - only if status is `PENDING` or `FAILED`. - [Create dispute fraud report](https://developers.pismo.io/pismo-docs/reference/post-v1-disputes-fraud-report.md): Create a dispute fraud report and one related installment. - [Update dispute fraud report](https://developers.pismo.io/pismo-docs/reference/put-v1-disputes-fraud-report.md): Update a fraud report. - [Create fraud report](https://developers.pismo.io/pismo-docs/reference/post-v2-fraud-report.md): Create a fraud report. This endpoint generates a [Fraud report created](https://developers.pismo.io/events/docs/fraud-report-fraud-report-creation-1) event. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. - [Get fraud report](https://developers.pismo.io/pismo-docs/reference/get-v2-fraud-report.md): Get a fraud report. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. - [Update fraud report](https://developers.pismo.io/pismo-docs/reference/put-v2-fraud-report.md): Update a fraud report. This endpoint generates a [Fraud report updated](https://developers.pismo.io/events/docs/fraud-report-fraud-report-change-1) event. **Notes:** * This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. * You can only update a fraud report if its status is not `PENDING`. - [List fraud report logs](https://developers.pismo.io/pismo-docs/reference/get-v1-fraud-report-logs.md): Retrieve a fraud report's logs. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. - [Get possible dispute states](https://developers.pismo.io/pismo-docs/reference/get-v1-disputes-disputeid-possible-status.md): Get possible states for a specified dispute. See Disputes state machine. - [Get possible states](https://developers.pismo.io/pismo-docs/reference/get-v1-disputes-possible-status.md): Get possible dispute states given a state machine and dispute status. See Disputes state machine for more information. - [Create dispute fee](https://developers.pismo.io/pismo-docs/reference/post-v1-fee.md): A dispute fee, or *fee collection* in network terminology, is a way for an acquirer and issuer to exchange money outside the normal chargeback process. Typically, this means reversing a settled chargeback, but not always, You can use this endpoint to create a dispute fee with or without a chargeback claim ID. You can create a dispute fee for a claim that already exists or, if it doesn't, you can pass the necessary authorization information to create it. For more information, refer to [Dispute fees](doc:disputes-overview#dispute-fees) in the Disputes overview guide. This feature is only available for Mastercard and Elo. This endpoint generates a [Dispute fee status created](https://developers.pismo.io/events/docs/disputes-dispute-fee-events-1) event. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. - [List dispute fees](https://developers.pismo.io/pismo-docs/reference/get-v1-fee.md): Get a list of fees with filter and paging options. - [Get dispute fee](https://developers.pismo.io/pismo-docs/reference/get-v1-fee-disputefeeid.md): Get information about a specific dispute fee given its ID in the path. You can get fee IDs with the [List dispute fees](ref:get-v1-fee) endpoint. - [Update dispute fee](https://developers.pismo.io/pismo-docs/reference/put-v1-fee-disputefeeid.md): Update dispute fee - only if status is `PENDING` or `FAILED`. Requires a dispute fee ID in the path. You can get fee IDs with the [List dispute fees](ref:get-v1-fee) endpoint. - [Create fee V2](https://developers.pismo.io/pismo-docs/reference/create-fee-v2.md): A fee, or *fee collection* in network terminology, allows acquirers and issuers to exchange money outside the standard chargeback process. Typically, this means reversing a settled chargeback, but not always. You can use this endpoint to create a fee collection/funds disbursement with or without a chargeback **case number**. You can create a fee collection/funds disbursement for an existing **case**, or, if it doesn't exist, you can provide the necessary transaction/card information to create it. The main differences between fees V2 and V1 are: * V1—Associated with the dispute/installment * V2—Can only be created with transaction ID (Full balance), transaction information (Zero balance), card ID and customer ID, or NetworkCaseID (VisaCaseNumber). For more information, refer to [Dispute fees](https://developers.pismo.io/pismo-docs/docs/disputes-overview#dispute-fees) in the Disputes overview guide. This feature is **only** currently available for **Visa**. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. - [Get fee V2](https://developers.pismo.io/pismo-docs/reference/get-fee-v2.md): Get details about a specific fee. - [Create dispute migration](https://developers.pismo.io/pismo-docs/reference/post-migration-with-auth.md): Create a migration for a Full balance or Zero balance program. After this, you can create a [dispute migration for a specific installment](ref:post-migration-installment) using the dispute ID returned here. This endpoint generates a [Dispute installment created](https://developers.pismo.io/events/docs/disputes-dispute-installment-creation-1) event. Once the dispute is migrated into the system, its status changes and a [Dispute status changed](https://developers.pismo.io/events/docs/disputes-dispute-installment-status-change-1) event is generated. - [Create installment migration](https://developers.pismo.io/pismo-docs/reference/post-migration-installment.md): Create a migration for a specific installment. Before you do this, you need to call [Create dispute migration](ref:post-migration-with-auth) and get a dispute ID to use here. This endpoint generates a [Dispute installment created](https://developers.pismo.io/events/docs/disputes-dispute-installment-creation-1) event. Once the dispute is migrated into the system, its status changes and a [Dispute status changed](https://developers.pismo.io/events/docs/disputes-dispute-installment-status-change-1) event is generated. - [Update dispute migration](https://developers.pismo.io/pismo-docs/reference/put-update-migration.md): Update dispute migration. Only use this endpoint if the dispute's status is `FAILED_MIGRATION` and you need to update something that went wrong. - [Get card on file](https://developers.pismo.io/pismo-docs/reference/list-cardonfile.md): Get card on file **Note**: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get account cards on file](https://developers.pismo.io/pismo-docs/reference/list-all-cardsonfile-registries.md): Get all cards on file for a specific account, which is derived from the access token. **Note**: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Update card on file](https://developers.pismo.io/pismo-docs/reference/updates-a-cardsonfile.md): Updates a card on file - change the card name, status, or profile. You must pass the card uuid token as a body parameter to identify the card. Fields that are not passed are not updated. This endpoint generates a [Card on file updated](https://developers.pismo.io/events/docs/cardsonfile-patch-cards-1) event. If the card status is being changed to `SUSPENDED`, it also generates a [Card excluded](https://developers.pismo.io/events/docs/cardsonfile-exclusion-1) event. **Note**: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Create card on file](https://developers.pismo.io/pismo-docs/reference/create-a-cardsonfile.md): Create a *card on file* - an existing card that has been tokenized and stored in a digital wallet. The token is then used for payment transactions to avoid exposing sensitive data like the card's PAN and CVV.
The card can be a Pismo-issued card or an external card. The card is added to the customer's digital wallet.
This endpoint generates a [Card on file created](https://developers.pismo.io/events/docs/cardsonfile-provision-1) event. **Note**: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Create card validation](https://developers.pismo.io/pismo-docs/reference/create-a-new-validation-for-a-given-card.md): Create a new invoice validation for a given tokenized card. A random transacation amount between 1.00 and 5.00 (later chargebacked) is created for the cardholder to approve, which requires logging into an online banking account. The cardholder has up to 3 tries and 96 hours to input the correct amount. If the validation fails, the card is deleted from the wallet.
This endpoint generates a [Card on file validation result received](https://developers.pismo.io/events/docs/cardsonfile-verification-1) event. If the validation fails, it generates an [Card excluded](https://developers.pismo.io/events/docs/cardsonfile-exclusion-1) event. **Note**: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [List card validations](https://developers.pismo.io/pismo-docs/reference/list-all-validations-for-a-given-card.md): Get all validations for a card currently outstanding. **Note**: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get card validation](https://developers.pismo.io/pismo-docs/reference/get-a-specific-validation-for-a-given-card.md): Gets a specific validation for a card **Note**: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Submit validation try](https://developers.pismo.io/pismo-docs/reference/submit-a-validation-try.md): Submit a validation try with amount.
This endpoint generates a [Card on file validation result received](https://developers.pismo.io/events/docs/cardsonfile-verification-1) event with `PENDING` status. If the verification/validation fails, a [Card excluded](https://developers.pismo.io/events/docs/cardsonfile-exclusion-1) event is generated and the card is deleted from the customer's wallet. **Note**: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Get card validation amount](https://developers.pismo.io/pismo-docs/reference/get-a-specific-validation-amount-for-a-given-card.md): Gets the validation amount for a specific card validation **Note**: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Delete card metadata](https://developers.pismo.io/pismo-docs/reference/delete-a-metadata-field-for-a-given-card.md): Deletes card metadata. This endpoint generates a [Card metadata deleted](https://developers.pismo.io/events/docs/cardsonfile-delete-metadata-1) event. **Note**: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment. - [Register card with Protection Bulletin](https://developers.pismo.io/pismo-docs/reference/post-v1-bulletin.md): Register a Pismo-issued card with the Protection Bulletin. This feature is available for Elo, Mastercard and Visa. The Protection Bulletin is used before a transaction takes place in cases where the issuer is temporarily offline and unable to authorize or decline a transaction. In a process known as *stand-in*, the card network authorizes or declines the transaction to avoid creating problems for the cardholder and merchant, based on how the card was added to the Protection Bulletin. Once the issuer is back online, the card network lets them know what was authorized or declined while they were down. You can add a card to the Protection Bulletin with this endpoint or [setting a card rule](ref:post-v1-bulletin-setup) so that when a card's status changes to a rule's configured status, the card is automatically added to the Protection Bulletin. For more information, refer to [Protection Bulletin](doc:protection-bulletin). **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. - [List cards in Protection Bulletin](https://developers.pismo.io/pismo-docs/reference/list-v1-bulletin.md): Get all Pismo-issued cards in the Protection Bulletin with filtering options. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. - [Delete card from Protection Bulletin](https://developers.pismo.io/pismo-docs/reference/delete-v1-bulletin.md): Remove a Pismo-issued card from the Protection Bulletin. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. - [Get Protection Bulletin card](https://developers.pismo.io/pismo-docs/reference/get-v1-bulletin.md): Gets a Pismo-issued card in the Protection Bulletin and its history. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. - [Create Protection Bulletin rule](https://developers.pismo.io/pismo-docs/reference/post-v1-bulletin-setup.md): Register a new Protection Bulletin setup rule. This feature is available for Elo, Mastercard and Visa. When you set a card rule, for example, when a card status is changed to `LOST`, it is automatically added to the Protection Bulletin. This operation executes asynchronously. When complete, a [Bulletin rule event](https://developers.pismo.io/events/docs/bulletin-bulletin-rule-1) is generated. **Notes:** * This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. * Deactivating a rule after it has been created requires re-calling this endpoint with `active` set to `false`. - [Get Protection Bulletin rule](https://developers.pismo.io/pismo-docs/reference/get-v1-bulletin-rule.md): Gets a Protection Bulletin rule. The information requested is not returned in the endpoint response. Instead, the information is sent in a [Bulletin rule event](https://developers.pismo.io/events/docs/bulletin-bulletin-rule-1). **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message. - [Perform clearing reconciliation](https://developers.pismo.io/pismo-docs/reference/performclearingreconciliation.md): Perform clearing reconciliation using the provided clearing message. The clearing message must be pending to enable reprocessing. - [Enroll card in VFC](https://developers.pismo.io/pismo-docs/reference/enroll-card-enrollment.md): Enrolls/registers a card in Visa Flexible Credentials (VFC). VFC enables a single card to access multiple funding sources, such as debit, credit, prepaid, and installment plans. For more information, refer to [Visa Flexible Credentials](doc:visa-flexible-credentials). - [Get card enrollment](https://developers.pismo.io/pismo-docs/reference/get-card-enrollment.md): Get VFC card enrolled/registered credentials. - [Delete card enrollment](https://developers.pismo.io/pismo-docs/reference/delete-card-enrollment.md): Delete card enrolled/registered credentials in VFC accounts. - [Update card enrollment](https://developers.pismo.io/pismo-docs/reference/update-card-enrollment.md): Update card existing enrolled/registered credentials in VFC accounts. **Note:** This endpoint takes an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** error. - [Create card relationships](https://developers.pismo.io/pismo-docs/reference/create-card-relationship.md): Create relationships between primary and secondary cards. - [List card relationships](https://developers.pismo.io/pismo-docs/reference/get-card-relationship.md): List relationships for a given primary card. - [Update card relationships](https://developers.pismo.io/pismo-docs/reference/update-card-relationship.md): Update relationships for a given primary card. - [Delete card relationships](https://developers.pismo.io/pismo-docs/reference/delete-card-relationship.md): Delete relationships for a given primary card. - [Create rules](https://developers.pismo.io/pismo-docs/reference/create-card-rules.md): Create rules for a primary card. - [List card rules](https://developers.pismo.io/pismo-docs/reference/get-card-rules.md): Retrieve card rules for a given primary card. - [Update card rules](https://developers.pismo.io/pismo-docs/reference/update-card-rules.md): Update rules for a given primary card. - [Delete card rules](https://developers.pismo.io/pismo-docs/reference/delete-card-rules.md): Delete rules for a given primary card. (Rules in response represents the remaining rules after deleting the rule mentioned in the request). - [Delete rule](https://developers.pismo.io/pismo-docs/reference/delete-specific-card-rule.md): Delete specific rule for a given primary card. (Rules in response represents the remaining rules after deleting the rule mentioned in the request) - [Create program transaction type](https://developers.pismo.io/pismo-docs/reference/createprogramtransactiontype.md): A program transaction type is used to associate a transaction type with a transaction category. It can also be used to set the charge order. For more information, refer to [Using configurable entities](doc:full-balance-credit-program#using-configurable-entities). **Note:** Only debit transactions and transactions that impact the statements can be used to create program transaction types. Use the [List transaction types](ref:searchtransactiontypes) endpoint to see if a transaction type is a debit (`credit` = `false`) and if it impacts the statement (`posted_transaction` = `true`). - [Configure account accrual rates](https://developers.pismo.io/pismo-docs/reference/postaccountaccrualtypesrates.md): Configure accrual rates for individual accounts. To do this, you must first configure the rates at the program level using the Configure program accrual rates endpoint. Then, use this endpoint to override the configuration for an individual account. Use the `accrual_type` field to specify the type of accrual. The `periodToCalculate` must be set to `UNTIL_DUE_DATE`, which means the accrual stops accruing when the due date is reached. NOTE: This endpoint requires an account-specific access token. Getting an account token requires you to call [Get OpenID access token](ref:post-passport-v1-oauth2-token-1) with an external account ID. Tokens can expire quickly, which can result in an Unauthorized message. - [List account accrual rates](https://developers.pismo.io/pismo-docs/reference/listaccountaccrualtyperates.md): Retrieves a list of accrual rates configured at the account level. NOTE: This endpoint requires an account-specific access token. Getting an account token requires you to call [Get OpenID access token](ref:post-passport-v1-oauth2-token-1) with an external account ID. Tokens can expire quickly, which can result in an Unauthorized message. - [Delete account accrual rates](https://developers.pismo.io/pismo-docs/reference/deleteaccountaccrualtypesrate.md): Deletes an accrual rate that's configured for an individual account. If only `accountId` is provided, all account accrual rates are deleted for that account. You can use the optional parameters `transactionCategoryId`, `accrualType`, and `periodToCalculate` to specify a subset of the account accrual rates that you want to delete. For example, if you provide values for `transactionCategoryId`, `accrualType`, and `periodToCalculate`, then all account accrual rates configured for the specified account, transaction category, accrual type, and period to calculate are deleted. NOTE: This endpoint requires an account-specific access token. Getting an account token requires you to call [Get OpenID access token](ref:post-passport-v1-oauth2-token-1) with an external account ID. Tokens can expire quickly, which can result in an Unauthorized message. - [Configure program accrual rates](https://developers.pismo.io/pismo-docs/reference/postaccrualtypesrates.md): Configure accrual rates at the program level. - [List program accrual rates](https://developers.pismo.io/pismo-docs/reference/listprogramaccrualtypesrates.md): Retrieves a list of accrual rates configured at the program level. - [Delete program accrual rates](https://developers.pismo.io/pismo-docs/reference/deleteaccrualtypesrates.md): Deletes an accrual rate that's configured for a program. If only `programId` is provided, all program accrual rates are deleted for that program. You can use the optional parameters `transactionCategoryId`, `accrualType`, and `periodToCalculate` to specify a subset of the program accrual rates that you want to delete. For example, if you provide values for `transactionCategoryId`, `accrualType`, and `periodToCalculate`, then all program accrual rates configured for the specified program, transaction category, accrual type, and period to calculate are deleted. - [Configure features by account status](https://developers.pismo.io/pismo-docs/reference/postfeaturesbyaccountstatus.md): Configure features by account status at the program or organization level. Note: This only applies to full balance credit card programs. You can toggle the following features on or off for a particular account status by setting them to `true` or `false`, respectively. By default, all these features are on (`true`). * `close-statements`: If `false`, the platform doesn't perform any cycle closings if the account has the specified status. * `late-payment-fee`: If `false`, the platform doesn't charge any late payment fees if the account has the specified status. * `overlimit`: If `false`, the platform doesn't charge any overlimit fees if the account has the specified status. * `create-accruals`: If `false`, the platform doesn't calculate new accruals if the account has the specified status. For example, suppose you set the `close-statements` feature to `false` for the `CANCELLED` account status for a specific program. (That is, you turn the feature off at the program level.) Then the Pismo platform won't perform any cycle closings for accounts in that status if they belong to that program. Important: Once the status is set to bypass the billing cycle closure and the account reaches that status, it cannot revert to a previous status. In other words, no further cycle closures can occur for this account. The change is irreversible. There are several points you should keep in mind when using this endpoint. * You can use this endpoint to set a feature toggle at the organization level, whether or not you have created any full balance credit programs in your organization. However, if you try to use it to set a feature toggle at the program level, and the program isn't a full balance credit card program, the endpoint throws an error. * If a feature is set to `true` or `false` at the program level, this overrules that feature's setting at the organization level. For example, if `close-statements` is set to `false` at the organization level and `true` at the program level, then the platform continues to perform cycle closings for accounts in the specified program. In other words, the organization level setting is ignored. * If a feature is not set to `true` or `false` at either the program or organization level, it defaults to `true`. * You can't use this endpoint to update a feature setting for an account status if it has already been configured at a particular level. For that, you need to use [Update features by account status](ref:patchfeaturesbyaccountstatus). You can use the [List statuses](ref:v4-get-account-status) endpoint to list all the account statuses defined for your organization. - [List features by account status](https://developers.pismo.io/pismo-docs/reference/getfeaturesbyaccountstatus.md): List account statuses with the corresponding feature toggles at program or organization level. - [Update features by account status](https://developers.pismo.io/pismo-docs/reference/patchfeaturesbyaccountstatus.md): Update features by account status at the program or organization level. Note: This only applies to full balance credit card programs, and only features that were previously configured using [Configure features by account status](ref:postfeaturesbyaccountstatus) can be updated using this endpoint. You can toggle the following features on or off for a particular account status by setting them to `true` or `false`, respectively. By default, all these features are on (`true`). In the `FEATURES OBJECT` body parameter, `newKey`, `newKey-1`, and so on, must be one of these features. * `close-statements`: If `false`, the platform won't perform any cycle closings if the account has the specified status. * `late-payment-fee`: If `false`, the platform won't charge any late payment fees if the account has the specified status. * `overlimit`: If `false`, the platform won't charge any overlimit fees if the account has the specified status. When modifying an existing account status, all the features previously configured must be provided. Note: If you send a feature name that does not exist, the endpoint returns an error. A status can be removed if the `remove_status` flag is set to `true`. The configuration can be reset if the `reset_configuration` flag is set to `true`. Resetting the configuration causes all the features to go back to their default values (`true`). Note: if you set `reset_configuration` to true, and also try to update some features for that status, the endpoint generates the following error: Request body is missing: account_statuses field is not allowed when it is set to reset this configuration. You can use the [List statuses](ref:v4-get-account-status) endpoint to list all the account statuses defined for your organization. - [Create additional accrual type configuration](https://developers.pismo.io/pismo-docs/reference/post-additional-accrual-type-configuration.md): Enables an additional configuration on an accrual type for a specific transaction category and period to calculate. Any additional configuration that you enable modifies the default accrual behavior. **Note:** Pismo recommends you use this endpoint instead of [Enable additional configurations on accrual types](ref:postaccrualtypesconfigurations), which will eventually be deprecated. The new endpoint accepts all parameters in the request body, instead of in path parameters. ### Available Configurations | Configuration | `value` Required | Allowed `values` | Allowed values for `period_to_calculate` |---|---|---|---| | `ONCE_AFTER_TRANSACTION_DUE_DATE` | No | N/A | `UNTIL_DUE_DATE`, `AFTER_DUE_DATE` | `GRACE_DAYS_UNTIL_DUE_DATE_STRATEGY` | Yes | 1 or 2 | `UNTIL_DUE_DATE` ### Configuration details - `ONCE_AFTER_TRANSACTION_DUE_DATE`: By default, accruals on transactions with this transaction category occur on a daily basis. If this additional configuration is enabled, then, for each transaction, the accrual is calculated only once on the transaction due date. The `value` field is not required for this configuration. - `GRACE_DAYS_UNTIL_DUE_DATE_STRATEGY`: This configuration defines the grace days strategy for accruals calculated up to the due date. You must set `period_to_calculate` to `UNTIL_DUE_DATE`. The `value` field is required. Accepted values are 1 or 2 (meaning Strategy 1 or Strategy 2). The strategies are defined as follows. - **Strategy 1**: One good cycle restores grace. If the customer misses one cycle, interest is charged for that missed cycle. If the next cycle is fully paid by the due date, grace returns for the following cycle. - **Strategy 2**: Two consecutive good cycles are required to restore grace. If the customer misses one cycle, they normally pay interest for the missed cycle and for the next two recovery cycles before grace returns. ### `value` behavior - The `value` field accepts an integer (1 or 2). - For configurations that do not require `value` (for example, `ONCE_AFTER_TRANSACTION_DUE_DATE`), you can omit the `value` parameter. - For configurations that require `value` (for example, `GRACE_DAYS_UNTIL_DUE_DATE_STRATEGY`), you must provide a valid positive integer. - If you need to make a new configuration mandatory with a value, contact your Pismo representative for help with that—you can't configure it using the API. **Note:** Unlike other rates that you define using transaction categories or accrual type rates, when you enable the `ONCE_AFTER_TRANSACTION_DUE_DATE` configuration on an accrual type, the rate you define for that type is *not* divided by the interest rate period before it's applied. - [Enable additional configurations on accrual types](https://developers.pismo.io/pismo-docs/reference/postaccrualtypesconfigurations.md): Enable additional configurations on accrual types. Any additional configuration that you enable modifies the default accrual behavior. Specify configurations to enable by listing them as an array in the `configurations` body parameter. The following configuration is available. - `ONCE_AFTER_TRANSACTION_DUE_DATE`: By default, accruals on transactions with this transaction category occur on a daily basis. If this additional configuration is enabled, then, for each transaction, the accrual is calculated only once on the transaction due date. **Note:** Unlike other rates that you define using transaction categories or accrual type rates, when you enable the `ONCE_AFTER_TRANSACTION_DUE_DATE` configuration on an accrual type, the rate you define for that type is not divided by the interest rate period before it's applied. - [Disable additional configuration on accrual types](https://developers.pismo.io/pismo-docs/reference/deleteaccrualtypesconfigurations.md): Disable additional configurations on accrual types. Any additional configuration that you disable modifies the default accrual behavior. Specify configurations to be disabled by listing them as an array in the `configurations` body parameter. The following configurations are available. - `ONCE_AFTER_TRANSACTION_DUE_DATE` - `GRACE_DAYS_UNTIL_DUE_DATE_STRATEGY`
For information about these strategies, refer to the [Create additional accrual type configuration](ref:post-additional-accrual-type-configuration) API. - [List additional accrual type configurations](https://developers.pismo.io/pismo-docs/reference/findconfigurationbyfilter.md): Retrieves a list of additional accrual type configurations for a program, filtered by transaction category, accrual type, and period to calculate. Optionally, you can filter by a specific configuration name to retrieve only that configuration. The response includes both active and deleted configurations. Deleted configurations have a non-null `deleted_at` field. - [Create recurring charge plan](https://developers.pismo.io/pismo-docs/reference/create-recurring-charge-plan.md): Create a recurring charge plan. A recurring charge is a charge that is applied on a monthly basis for a fixed number of installments. When you create a recurring charge plan, you specify the number of installments (cycles) and the installment amount. Creating a plan does not activate it. A plan must be linked to an account to activate the charge schedule defined in it. This endpoint generates a [Recurring charge plan created](https://developers.pismo.io/events/docs/balance-recurring-charge-plan-created-1) event. **NOTES:** - To work correctly, you must set the program parameter [504 - RECURRING_CHARGE_FINAL_ACCOUNT_STATUS](doc:multivalue-parameters) to the value for an account status. Usually you use `CANCELLED` for this. When the account enters this status, the system cancels all pending recurring charges. (Note that if you provide more than one value, the system only uses the first one, even though this is a multivalue program parameter.) - This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [List recurring charge plans](https://developers.pismo.io/pismo-docs/reference/list-recurring-charge-plans.md): Returns a list of recurring charge plans. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Get recurring charge plan](https://developers.pismo.io/pismo-docs/reference/get-recurring-charge-plan.md): Gets a recurring charge plan by its ID. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Disable recurring charge plan](https://developers.pismo.io/pismo-docs/reference/disable-recurring-charge-plan.md): Disables an active recurring charge plan. Already disabled plans are unaffected. This endpoint generates a [Recurring charge plan disabled](https://developers.pismo.io/events/docs/balance-recurring-charge-plan-disabled-1) event. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Create link](https://developers.pismo.io/pismo-docs/reference/create-recurring-charge-link.md): Creates a link between an active recurring charge plan and an account. This endpoint generates a [Recurring charge plan linked to account](https://developers.pismo.io/events/docs/balance-recurring-charge-plan-linked-to-account-1) event. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Get link between a plan and an account](https://developers.pismo.io/pismo-docs/reference/get-recurring-charge-link.md): Gets the link between a plan and an account, given the plan ID and account ID. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Delete recurring charge link](https://developers.pismo.io/pismo-docs/reference/delete-recurring-charge-link.md): Cancels the link between a recurring charge plan and an account. Results in the cancellation of all `PENDING` charges for that link. Already canceled links are unaffected. This endpoint generates a [Recurring charge plan unlinked from account](https://developers.pismo.io/events/docs/balance-recurring-charge-plan-unlinked-from-account-1) event. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [List recurring charge plan links](https://developers.pismo.io/pismo-docs/reference/list-recurring-charge-links.md): Gets all the links for a plan, given the plan ID. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [List account links](https://developers.pismo.io/pismo-docs/reference/list-account-links.md): Gets the links for a given account. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [List scheduled charges](https://developers.pismo.io/pismo-docs/reference/list-scheduled-charges.md): Gets all the scheduled charges for a given account, filtered by the query parameters. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Get scheduled charge](https://developers.pismo.io/pismo-docs/reference/get-scheduled-charge.md): Get a scheduled charge by account ID and recurring scheduled charge ID. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Update scheduled charge](https://developers.pismo.io/pismo-docs/reference/update-scheduled-charge.md): Updates a scheduled charge by account ID and recurring scheduled charge ID. It's only possible to update charges with current status `PENDING`. An update to a charge that is scheduled for a particular cycle must be done before that cycle's closing date. This endpoint generates a [Recurring scheduled charge updated](https://developers.pismo.io/events/docs/balance-recurring-scheduled-charge-updated-1) event. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [List calendars](https://developers.pismo.io/pismo-docs/reference/listcalendars.md): List calendars for a program. You can use the following fields to filter the results. At most one of these fields should be filled. - `dueDay` - `programCalendarStrategyId` - `divisionId` - [Create program calendar strategy](https://developers.pismo.io/pismo-docs/reference/createprogramcalendarstrategy.md): Create a program calendar strategy. Program calendar strategies provide new methods of calendar creation. For example, in the `FIXED_CYCLE_CLOSING` strategy, the `cycle_closing_date` of the calendar is fixed, but the due date is dynamic. The due date is calculated from the values set in the `configuration` object. This endpoint generates a [Program calendar strategy created](https://developers.pismo.io/events/docs/balance-program-calendar-strategy-created-1) event. Note: This endpoint cannot be used to create a [fixed due date calendar](doc:fixed-due-date-calendars). - [List program calendar strategies](https://developers.pismo.io/pismo-docs/reference/listprogramcalendarstrategies.md): List program calendar strategies and their configurations. Note: This endpoint does not return information about a [fixed due date calendar](doc:fixed-due-date-calendars). - [Get program calendar strategy](https://developers.pismo.io/pismo-docs/reference/getprogramcalendarstrategy.md): Get a program calendar strategy by its ID. Note: This endpoint cannot be used to retrieve information about a [fixed due date calendar](doc:fixed-due-date-calendars). - [Update program calendar strategy](https://developers.pismo.io/pismo-docs/reference/updateprogramcalendarstrategy.md): Update a program calendar strategy. This endpoint generates a [Program calendar strategy updated](https://developers.pismo.io/events/docs/balance-program-calendar-strategy-updated-1) event. Note: This endpoint cannot be used to update a [fixed due date calendar](doc:fixed-due-date-calendars). - [Get account calendar strategy](https://developers.pismo.io/pismo-docs/reference/getacountcalendarstrategy.md): Get the calendar strategy for an account. Notes: - A program calendar strategy is defined for a specific program. However, it can be associated with an account in that program, so you can search for accounts that are associated with a particular program calendar strategy. - This endpoint does not return information about a [fixed due date calendar](doc:fixed-due-date-calendars). - [Update account calendar strategy](https://developers.pismo.io/pismo-docs/reference/updateacountcalendarstrategy.md): Update an account calendar strategy. After a program calendar strategy is defined using [Create program calendar strategy](ref:createprogramcalendarstrategy), you must use this endpoint to assign the strategy to an account. If you have more than one program calendar strategy defined for a program, you can also use this endpoint to change the strategy assigned to an account. This endpoint generates a [Balance account changed](https://developers.pismo.io/events/docs/balance-balance-account-change-1) event. Note: This endpoint cannot be used to update a [fixed due date calendar](doc:fixed-due-date-calendars). - [Close account cycle](https://developers.pismo.io/pismo-docs/reference/cycleclosingrequest.md): Close cycle for a specific account. - [Create payment agreement simulation](https://developers.pismo.io/pismo-docs/reference/create-payment-agreement-simulation.md): Create a payment agreement simulation. If successful, this endpoint generates a [Payment agreement simulation processed](https://developers.pismo.io/events/docs/balance-installment-payment-processed-1) event. If it fails, it generates a [Payment agreement simulation not processed](https://developers.pismo.io/events/docs/statement-refinancing-payment-agreement-simulation-not-processed-1) event. - [Get payment agreement simulation](https://developers.pismo.io/pismo-docs/reference/get-payment-agreement-simulation.md): Get a payment agreement simulation by its ID - [Get delinquent account closure process information](https://developers.pismo.io/pismo-docs/reference/delinquent-account-closure-get.md): Get a delinquent account closure entity that was accepted in the process. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Close delinquent account](https://developers.pismo.io/pismo-docs/reference/delinquent-account-closure-post.md): Sends the specified account to the delinquent account closure process. This endpoint generates a [Delinquent account closed](https://developers.pismo.io/events/docs/delinquent-account-delinquent-account-1) event. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Get delinquency bucket](https://developers.pismo.io/pismo-docs/reference/getdelinquencybuckets.md): Get account delinquency bucket given an account ID and bucket ID in the path. You can get delinquency bucket IDs from the [List delinquency buckets](ref:listdelinquencybuckets) endpoint. You can use delinquency buckets to control and manage cardholder delinquency. Buckets are created at cycle close. For more information, see the [Delinquency buckets](doc:delinquency-buckets) guide. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [List delinquency buckets](https://developers.pismo.io/pismo-docs/reference/listdelinquencybuckets.md): Get an account's delinquency buckets with filtering options. For more information, see the [Delinquency buckets](doc:delinquency-buckets) guide. **NOTE:** This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Create installment advancement](https://developers.pismo.io/pismo-docs/reference/createinstallmentadvancementv2.md): Creates an installment advancement for an account. An installment advancement moves one or more future installments to the current cycle. This version supports two advancement modes: **ALL_CONTRACTS mode**: Advances all future installments for all installment agreements in the account. When using this mode: - Set `condition` to `ALL_CONTRACTS`. - The `calculator`, `reschedule`, and `remove_interest_from_current` fields are required at the root level. - The `contracts` array should not be provided. **MULTIPLE_CONTRACTS mode**: Advances installments for specific contracts with individual configurations. When using this mode: - Set `condition` to `MULTIPLE_CONTRACTS`. - Provide a `contracts` array with individual contract configurations. - Root-level `calculator`, `reschedule`, and `remove_interest_from_current` fields must not be provided. When you advance installments, you must specify what to do with the interest. You have three options: 1. To remove 100% of the interest on the advanced installment(s), set the `remove_interest_from_current` field to `true` and the `calculator` field to `REMOVE_ALL_INTEREST`. 2. To advance 100% of the interest on the advanced installment(s), set `remove_interest_from_current` to `false` and set `calculator` to `NONE`. 3. To recalculate the interest applied to the advanced installment(s), set `calculator` to `PRESENT_VALUE`. You can set the `remove_interest_from_current` field to either `true` or `false`. If `true`, the system recalculates interest on installments that were already in the current cycle (and did not need to be advanced). Otherwise, interest on those installments remains unchanged. For more information, refer to [Installment advancements](doc:installment-management#installment-advancements) and [Creating an installment advancment](doc:installment-management#creating-an-installment-advancement). This endpoint triggers an async process in which the transactions are advanced as requested. - [Get installment advancement](https://developers.pismo.io/pismo-docs/reference/getinstallmentadvancementv2byid.md): Retrieves an installment advancement by its ID. This endpoint provides enhanced response data including: - Detailed advancement information with status tracking - Contract-specific configurations for MULTIPLE_CONTRACTS mode - Enhanced metadata including creation, update, and cancellation timestamps - Error messages when applicable The response format differs based on the advancement condition. - **ALL_CONTRACTS**: Returns root-level calculator, reschedule settings, and no contracts array. - **MULTIPLE_CONTRACTS**: Returns individual contract configurations in the contracts array. This endpoint includes additional fields like `cancelled_at`, `error_message`, `status`, and `contracts`. - [Cancel installment advancement](https://developers.pismo.io/pismo-docs/reference/cancelinstallmentadvancev2.md): Cancel an installment advancement. - [Create installment advancement (outdated)](https://developers.pismo.io/pismo-docs/reference/createinstallmentadvancement.md): Creates an installment advancement for an account. An installment advancement moves one or more future installments to the current cycle. To advance installments for a specific installment agreement (contract), set the `condition` field to `SINGLE_CONTRACT`, and set the `transaction_id` field to the transaction ID of any of the installments in the installment agreement. Specify the number of installments to advance in the `number_of_installments_to_advance` field. Installments are advanced starting with the last scheduled installment in the agreement and working backwards from there. To advance all future installments for all installment agreements in the account, set the `condition` field to `ALL_CONTRACTS`. (In this case, the `number_of_installments_to_advance` field is ignored.) When you advance installments, you must specify what to do with the interest. You have three options: 1. To remove 100% of the interest on the advanced installment(s), set the `remove_interest_from_current` field to `true` and the `calculator` field to `REMOVE_ALL_INTEREST`. 2. To advance 100% of the interest on the advanced installment(s), set `remove_interest_from_current` to `false` and set `calculator` to `NONE`. 3. To recalculate the interest applied to the advanced installment(s), set `calculator` to `PRESENT_VALUE`. You can set the `remove_interest_from_current` field to either `true` or `false`. If `true`, the system recalculates interest on installments that were already in the current cycle (and did not need to be advanced). Otherwise, interest on those installments remains unchanged. For more information, refer to [Installment advancements](doc:installment-management#installment-advancements) and [Creating an installment advancment](doc:installment-management#creating-an-installment-advancement). This endpoint generates an Installment advanced event. (Outdated: For an updated version of this endpoint, refer to [Create installment advancement](ref:createinstallmentadvancementv2)). - [Get installment advancement (outdated)](https://developers.pismo.io/pismo-docs/reference/getintallmentadvancementbyid.md): Retrieves an installment advancement by its ID. (Outdated: For an updated version of this endpoint, refer to [Get installment advancement](ref:getinstallmentadvancementv2byid)). - [Cancel installment advancement (outdated)](https://developers.pismo.io/pismo-docs/reference/cancelinstallmentadvancement.md): Cancel the installment advancement for an account, and return the installments to their original cycles. If necessary, reinstate original interest on the installments. This endpoint generates an Installment advanced cancelled event. (Outdated: For an updated version of this endpoint, refer to [Cancel installment advancement](ref:cancelinstallmentadvancev2)). - [Simulate installment advancement](https://developers.pismo.io/pismo-docs/reference/simulateinstallmentadvancement.md): Simulates an installment advancement for an account. That is, it simulates advancing one or more installments from a future cycle to the current cycle. To simulate advancing installments for a specific installment agreement (contract), set the `condition` query parameter to `SINGLE_CONTRACT`, and set the `transaction_id` query parameter to the transaction ID of any of the installments in the installment agreement. Specify the number of installments to advance in the simulation in the `number_of_installments_to_advance` query parameter. Installments are advanced starting with the last scheduled installment in the agreement and working backwards from there. To simulate advancing all future installments for all installment agreements in the account, set the `condition` field to `ALL_CONTRACTS`. (In this case, the `number_of_installments_to_advance` field is ignored.) When you simulate advancing installments, you must specify what to do with the interest. You have three options: - To simulate removing 100% of the interest on the advanced installment(s), set the `remove_interest_from_current` query parameter to `true` and the `calculator` query parameter to `NONE`. - To simulate advancing 100% of the interest on the advanced installment(s), set `remove_interest_from_current` to `false` and set `calculator` to `NONE`. - To simulate recalculating the interest applied to the advanced installments(s), set `calculator` to `PRESENT_VALUE`. The `remove_interest_from_current` parameter can be set to either `true` or `false`. If `true`, the interest on installments that were already in the current cycle (and did not need to be advanced) is recalculated in the simulation. Otherwise, interest on those installments is unchanged. For more information, see Installment advancements. This endpoint generates an Installment advanced event. - [Post interest accruals](https://developers.pismo.io/pismo-docs/reference/postinterestaccruals.md): The platform filters all accruals by `accrual_status` and, optionally, by `start_date` and `end_date`. For each accrual type in the results, it adds the values and posts one transaction for the total amount. The status for each accrual filtered is changed to `PROCESSED`. The `201 Created` HTTP status response code indicates that the accruals were processed. However, the process that posts the transactions on the account's statement is asynchronous. To check if all transactions were created, check the [Transaction created](https://developers.pismo.io/events/docs/transaction-creation-1) event to verify that a transaction was created for each `tracking_id` returned by the endpoint. You can use `start_date` and `end_date` to restrict the search to accruals in a specific date range (where the accrual date indicates when the client issued the asset). If you do not provide either date field, then the search returns results from any date. NOTE: This endpoint requires an account-specific access token. Getting an account token requires you to call [Get OpenID access token](ref:post-passport-v1-oauth2-token-1) with an external account ID. Tokens can expire quickly, which can result in an Unauthorized message. - [Configure minimum value by accrual type](https://developers.pismo.io/pismo-docs/reference/postaccrualtypeminimumvalue.md): Configure a minimum value for an accrual type. At cycle closing, if the calculated value for an accrual of that type is lower that the configured minimum value, the minimum value is used instead. This is an immutable configuration. So, to override a previous configuration, you have to create a new configuration for the same level in the hierarchy. The old configuration is maintained to track the changes, but it's not used. - [List minimum value configurations](https://developers.pismo.io/pismo-docs/reference/getaccrualtypeminimumvalue.md): List the minimum value configurations for an accrual type. - [Delete minimum value configuration](https://developers.pismo.io/pismo-docs/reference/deleteaccrualtypeminimumvalue.md): Delete a minimum value configuration for an accrual type. - [Create accrual type post configuration](https://developers.pismo.io/pismo-docs/reference/createaccrualtypepostconfig.md): Creates a new accrual type post configuration for the specified program. This configuration is used in posting transactions for accruals to statements. When a cycle closes, the Pismo platform retrieves the accrual type post configuration for the specific program and accrual type and uses the specified processing code when posting the accrual transactions. The reversal projection processing code is used to reverse projected accruals when the customer's payment date is between `cycle-closing-date` and `due-date` (or the real due date, if different from `due_date`). The Pismo platform creates transactions to perform the reversals and posts them on the statement. **Note:** Payments can be backdated, but future dates are not allowed. - [List accrual type post configurations](https://developers.pismo.io/pismo-docs/reference/getaccrualtypepostconfig.md): Retrieves a list of accrual type post configurations for a program. - [Update accrual type post configuration](https://developers.pismo.io/pismo-docs/reference/updateaccrualtypepostconfig.md): Update specific fields in an accrual type post configuration for a program. Notes: - If `reversal_projection_processing_code is omitted in request`, its value is updated to null. - If `processing_code` is omitted, its value remains unchanged. - [Update account collection status](https://developers.pismo.io/pismo-docs/reference/changeaccountcollectionstatus.md): Change an account's collection status from `NORMAL` to `OVERDUE` or vice-versa. `OVERDUE` accounts cannot do cash-outs (purchases, cash withdrawals, and so on). When you try to change an account's collection status to `OVERDUE`, the Pismo platform first verifies that `OpenDueDate` is not `NULL` and that it is a date in the past. If this test fails, it returns `400 Bad request`. No validations are done when you change the collection status to `NORMAL`. Changing the account collection status does not affect the [account status](doc:managing-account-statuses#account-statuses-common-to-all-accounts). So, for example, changing the account collection status from `NORMAL` to `OVERDUE` does not cause the account status to change to `BLOCKED`, even though it does prevent cash-outs by blocking the ledger itself. When you change the account collection status from `OVERDUE` to `NORMAL`, the ledger is unblocked and the account is again able to do cash-outs, assuming the account status is not `BLOCKED`. The two fields are not linked.
Collection status Account status Result
`NORMAL` `NORMAL` Account is usable.
`NORMAL` `BLOCKED` Account is not usable.
`OVERDUE` `NORMAL` Account is not usable.
`OVERDUE` `BLOCKED` Account is not usable.
For more information about the account collection status, refer to the [Credit liquidation](doc:credit-liquidation) guide. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Create or update account transaction category](https://developers.pismo.io/pismo-docs/reference/saveaccounttransactioninterest.md): Create or update a account transaction category. If an existing account transaction category is found (same `account_id` and `transaction_category_id`), it is updated. Otherwise, a new one is created. For an interest rate, for example `fine_rate`, the field `fine_rate` or `fine_rate_multiplier_percent` **must** be passed. You can pass one or the other but not both. This rule applies to all interest rate fields. However, you can combine fixed amounts and multipliers for different interest rates. Note that zero (0) is considered a valid value. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [List account transaction category rates](https://developers.pismo.io/pismo-docs/reference/getaccountstransactionsinterest_1.md): List all account transaction category rates, canceled or active. An active rate has the attribute `cancelled_at` set to `null`. Since there can be more than one account transaction category per account, there might be more than one active rate. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Cancel account transaction category](https://developers.pismo.io/pismo-docs/reference/cancelaccounttransactioncategory.md): Cancel an account transaction category. If the passed account transaction category is already canceled, an exception is raised. When you cancel an account transaction category, the account reverts back to using the rates defined in the program-level transaction category. For more information about program transaction categories, refer to [Transaction category structure](doc:configuring-accrual-rates#transaction-category-structure). **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Get interest accrual summary](https://developers.pismo.io/pismo-docs/reference/getinterestaccrualsummarization.md): Get an account interest accrual summary with filter options. Using the `beginDate` and `endDate` query parameters, you can specify a time period of up to 60 days. However, for the period between 31 and 60 days, the `interest_accruals_ids` field is omitted in the response. This is done because the list of IDs can get very large for a 60-day period. If you specify a period greater than 60 days, the endpoint returns an error. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [List account accruals v3](https://developers.pismo.io/pismo-docs/reference/getaccountaccrualsv3.md): List account accruals with filtering options. You must specify the period using `beginDate` and `endDate`, and this period must be less than or equal to 30 days. If you specify a period greater than this, the endpoint returns an error. The period is restricted to 30 days for performance reasons. A larger period could return a very large number of accruals. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Update interest accrual statuses](https://developers.pismo.io/pismo-docs/reference/getaccountstransactionsinterest.md): Update the statuses of one or more interest accruals. You can use accrual type and accrual IDs to filter interest accruals. You can change an interest accrual's status to PENDING, STOP_ACCRUAL, or SETTLED. If the current status is PROCESSED, it cannot be changed. As a result, this endpoint could return two lists, one for updated accruals and one for not updated accruals. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [List account accruals v2](https://developers.pismo.io/pismo-docs/reference/getaccountaccrualsv2.md): List account accruals with filtering options. Note: This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Create installment advancement (no cancellation event)](https://developers.pismo.io/pismo-docs/reference/installmentadvancedv2.md): Create an installment advancement. An installment advancement is a transfer of one or more installments from future cycles to the present cycle. For more information, refer to [Manage installments on the customer statement](doc:installments-payment#manage-installments-on-the-customer-statement). This endpont generates an [Installment advanced](https://developers.pismo.io/events/docs/balance-installment-advancement-1) event. **Notes:** - Cancelling an installment advancement created with this endpoint does not generate a cancellation event. Pismo recommends that you use the most advanced version of the installment advancement endpoints instead:
[Create installment advancement](ref:createinstallmentadvancementv2)
[Get installment advancement](ref:getinstallmentadvancementv2byid)
[Cancel installment advancement](ref:cancelinstallmentadvancev2) - This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Get simulation installment advancement](https://developers.pismo.io/pismo-docs/reference/getinstallmentadvancedsimulationv2.md): Get a simulation installment advancement with filtering options. - [Get installment advancement (no cancellation event)](https://developers.pismo.io/pismo-docs/reference/getinstallmentsadvancev2.md): Get an installments advancement by account ID and installments advancement ID. This endpont generates an [Installment advanced](https://developers.pismo.io/events/docs/balance-installment-advancement-1) event. **Notes:** - Cancelling an installment advancement created with this endpoint does not generate a cancellation event. Pismo recommends that you use the most advanced version of the installment advancement endpoints instead:
[Create installment advancement](ref:createinstallmentadvancementv2)
[Get installment advancement](ref:getinstallmentadvancementv2byid)
[Cancel installment advancement](ref:cancelinstallmentadvancev2) - This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Cancel installments advancement (no cancellation event)](https://developers.pismo.io/pismo-docs/reference/cancelinstallmentsadvancev2.md): Cancel an installment advancement by account ID and advancement ID. This endpont generates an [Installment advanced](https://developers.pismo.io/events/docs/balance-installment-advancement-1) event. Notes: Cancelling an installment advancement created with this endpoint does not generate a cancellation event. Pismo recommends that you use the most advanced version of the installment advancement endpoints instead:
[Create installment advancement](ref:createinstallmentadvancementv2)
[Get installment advancement](ref:getinstallmentadvancementv2byid)
[Cancel installment advancement](ref:cancelinstallmentadvancev2) - [List discharges](https://developers.pismo.io/pismo-docs/reference/getaccountdischargetracking.md): Track discharges for an account. A discharge occurs when a credit transaction is used to reduce the balance of a debit transaction. This endpoint returns a list of credit transactions along with the debit transactions that they were used to discharge. You can filter the list by `creditTransactionId`, `CreditTransactionBeginDate`, and `CreditTransactionEndDate`. If an invalid value is entered for `creditTransactionBeginDate` or `creditTransactionEndDate`, the endpoint returns `400 - Bad Request`. An example of an invalid value would be if `creditTransactionEndDate` is an earlier date than `creditTransactionBeginDate` or if `creditTransactionBeginDate` is more than 184 days in the past. - [Save program due date](https://developers.pismo.io/pismo-docs/reference/saveprogramduedate.md): Save a program due date. Day **must** be between 1 and 28. (**Note:** Due date is *required* for credit full-balance program types.) When you execute this endpoint, the Pismo platform first checks to see if the specified due date already exists. If it finds an existing due date with the same values for `day` and `grace_period_days`, it considers this a match and determines that the specified due date already exists. In this case, there are two possibilities. - If `active` has the same value in both the existing due date and the request, the request does nothing. - If `active` has a different value in the request, the value of `active` in the existing due date is updated accordingly. In other words, you can use this endpoint to activate or deactivate an existing due date. Note:The preferred way of updating existing due dates is to use the [Update program due date](ref:updateprogramduedate) endpoint. If the platform does not find a match, then it creates a new due date. (Note: This means that you could end up with two due dates that have the same value for `day`, but different values for `grace_period_days`.) - [List program due dates](https://developers.pismo.io/pismo-docs/reference/getprogramduedates.md): List a program's due dates with filtering options. If a value for the `programDueDateId` query parameter is provided, the request returns either a list with only one item or no items if there is no program due date with this ID. - [List available due dates](https://developers.pismo.io/pismo-docs/reference/getavailableduedates1.md): List available due dates with filtering options. **Note: This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Update statements calendar](https://developers.pismo.io/pismo-docs/reference/statementduedate.md): Update the calendar for one or more statements. **Notes:** - To function properly, the calendar must be updated no later than two days before the cycle closes. - The endpoint only works for [fixed due date calendars](doc:fixed-due-date-calendars). For other types of calendars, refer to the [Calendar management strategies](doc:calendar-management-strategies) guide. - This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Update program due date](https://developers.pismo.io/pismo-docs/reference/updateprogramduedate.md): Update a program due date. - [Change due date](https://developers.pismo.io/pismo-docs/reference/updatestatementsduedate.md): Update the due date for all subsequent account statements. The new due date must always be greater than the current due date to avoid inconsistencies in the platform. **Important:** The due date must be updated no later than two days before the cycle closes. If you try to update the due date within a day of the cycle closing date, the endpoint generates an error. This behavior is necessary to ensure accuracy on cycle closing and data consistency. By default, you can only update the due date once per credit cycle. If you update the due date, and then try to update it again before the end of the same cycle, the endpoint returns an error. This behavior can be disabled by setting the [Due date exchange control](doc:program-parameters-reference-table) program parameter to `false`. **Notes:** - Due date is *required* for credit full balance program types. - This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized message**. - [Create or update statement minimum amount due](https://developers.pismo.io/pismo-docs/reference/createstatementamountdue.md): Create statement minimum amount due (MAD) for the current cycle, or update it if it already exists. Using this endpoint bypasses the configured strategy for calculating the MAD. For more information, refer to [Minimum amount due calculation](doc:minimum-amount-due-calculation). **Notes:** - Running this endpoint bypasses the configured strategy only for the **current** cycle. The configured strategy, if it exists, still applies to future statements. - To use this endpoint, the **Allow overriding the minimum amount due for the current statement** program parameter must be set to `true`. Otherwise, the endpoint generates an error. - [Get statement minimum amount due](https://developers.pismo.io/pismo-docs/reference/getstatementamountdue.md): Get the statement minimum amount due by account ID and statement ID. - [Disable statement minimum amount due](https://developers.pismo.io/pismo-docs/reference/deletestatementamountdue.md): Disable the current statement minimum amount due. - [Create payment agreement](https://developers.pismo.io/pismo-docs/reference/installmentpaymentsv4.md): Create a payment agreement and post the refinanced debt as new installment transactions, beginning from the currently open statement. The `statement_agreement` and `compulsory` flags are used to specify the transaction types of the transactions that are created on the customer's statement. Here are the possible combinations. Type of payment agreement: Statement agreement Description: The customer renegotiates all debt for all their statements. `statement_agreement`: true `compulsory`: false Transaction types of transactions: 712 (INSTALLMENT AGREEMENT) 711 (CREDIT BY AGREEMENT) 713 (CONTRACT AGREEMENT) Type of payment agreement: Installment agreement Description: This an agreement that the customer makes with their credit card issuer stating that they aren't able to pay off their debt within the current month, so they intend to settle the amount over the next few bills. In other words, the amount that remains outstanding is added to their statement for the following month. `statement_agreement`: false `compulsory`: false Transaction types of transactions: 702 (REFINANCING INSTALLMENT) 701 (INSTALLMENT CREDIT) 703 (REFINANCING CONTRACT) Type of payment agreement: Compulsory agreement Description: This is the same as an installment agreement, except that it's the result of a renegotiation that was made independently of the customer. This is mandatory in Brazil, due to a measure initiated by the Central Bank to protect customers from revolving credit interest charged on the unpaid amount of the invoice. According to this measure, after 30 days, the bank or financial institution must offer more advantageous conditions for the customer to pay off the debt. In practice, the amount owed is automatically divided into installments, allowing the user to fit the payment of the debt into their monthly budget. `statement_agreement`: false `compulsory`: true Transaction types of transactions: 722 (CP REFINANCING INSTALLMENT) 721 (CP INSTALLMENT CREDIT) 723 (CP REFINANCING CONTRACT) Notes: - The installment transactions for the refinanced debt have transaction type `REFINANCING AGREEMENT`. - The following combination is not valid. It returns the error message "A compulsory request requires the statement agreement field to be set to false." `statement_agreement`: true `compulsory`: true - After the installments are created, the Pismo platform asynchronously generates an [Installment payment processed](https://developers.pismo.io/events/docs/balance-installment-payment-processed-1) event. You should not try to access the new payment agreement until you receive this event. - [List payment agreements](https://developers.pismo.io/pismo-docs/reference/getinstallmentpayments.md): List payment agreements for a specified account. - [Get payment agreement](https://developers.pismo.io/pismo-docs/reference/getinstallmentpaymentbypaymentagreementid.md): Get a payment agreement by account ID and payment agreement ID. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Cancel payment agreement](https://developers.pismo.io/pismo-docs/reference/deleteinstallmentpaymentbypaymentagreementid.md): Cancel a payment agreement by account ID and payment agreement ID. **Note:** A payment agreement can only be canceled within 30 days of the creation date. If you try to cancel an agreement after 30 days, the endpoint returns a 400 error with the message: 'Payment Agreement cancellation period expired'. - [Update agreement original rate](https://developers.pismo.io/pismo-docs/reference/updateuseroriginalrate.md): Update a payment agreement's `use_original_rate` attribute. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Create program transaction category](https://developers.pismo.io/pismo-docs/reference/createtransactioncategory.md): Create a program transaction category. Program transaction categories are used to group transaction types and set properties for the group. Transaction types, in combination with processing codes, are used to define how financial operations are implemented on the Pismo platform. For more information, refer to [Using configurable entities](doc:full-balance-credit-program#using-configurable-entities) and [Transaction category structure](doc:configuring-accrual-rates#transaction-category-structure). - [List program transaction categories](https://developers.pismo.io/pismo-docs/reference/listtransactioncategoryinterest.md): List program transaction categories with filtering options. - [Update program transaction category](https://developers.pismo.io/pismo-docs/reference/updatetransactioncategoryinterest.md): Update a program transaction category by ID. - [Get current statement](https://developers.pismo.io/pismo-docs/reference/getcurrentstatement.md): Get the current statement by account ID. For more information about statements, refer to [Understanding statements](doc:understanding-statements). **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Get statement](https://developers.pismo.io/pismo-docs/reference/getstatementinfo.md): Get a statement by account ID and statement ID. For more information about statements, refer to [Understanding statements](doc:understanding-statements). **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [List statements](https://developers.pismo.io/pismo-docs/reference/getbystatementid.md): List account statements. For more information about statements, refer to [Understanding statements](doc:understanding-statements). The filter parameters have the following order of precedence: 1. `startFromCurrentCycle` 2. `presentToFront` 3. `presentToPast` That is, if `startFromCurrentCycle` is `true`, then `presentToFront` and `presentToPast` are ignored. If `startFromCurrentCycle` is `false` (or not set), and `presentToFront` is `true`, then `presentToPast` is ignored. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Get account total due](https://developers.pismo.io/pismo-docs/reference/gettotaldue.md): Get the total amount due for an account. - [List transaction balances](https://developers.pismo.io/pismo-docs/reference/gettransactionsbalance.md): List transaction balances. Use this endpoint to retrieve the details for one or more transactions. This endpoint could be useful if your customer has a dispute or needs credit card refinancing. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Get minimum payout calculation memory](https://developers.pismo.io/pismo-docs/reference/getminimumpaymentcalculationmemory.md): Get a minimum payment calculation memory for a specific account statement. The minimum payout calculation memory is the information used in the [calculation of the minimum amount due (MAD)](doc:minimum-amount-due-calculation) and the results of that calculation. This this information in a JSON file. For example, in the following sample result, the default calculation strategy was used, the resulting MAD was 150, and two transactions were used in the calculation. { "id": 1, "created_at": "2021-08-10T00:00:00", "org_id": "TN-e7091464-aa1e-4c20-8c68-1e4c57741234", "account_id": 1010, "statement_id": 1, "calc_strategy": "DEFAULT", "minimum_amount": 150, "calculation_memory": [ { "type": "PREVIOUS_STATEMENT_TRANSACTION", "cycle": 4, "amount": 43.74, "balance": 43.74, "percentage": 1.0, "transaction_id": 77489 }, { "type": "CURRENT_STATEMENT_TRANSACTION", "cycle": 5, "amount": 3.65, "balance": 3.65, "percentage": 1.0, "transaction_id": 77542 } ] } The `calc_strategy` field has three possible values: `DEFAULT`, `PERCENTAGE_ONLY`, and `FIXED_PERCENTAGE_WITH_OVERLIMIT_AND_OVERDUE_AMOUNT`. These values correspond to the three possible settings for the `Minimum payment calculation method` program parameter: 0, 1, and 2. That is, `DEFAULT` = 0, `PERCENTAGE_ONLY` = 1, and `FIXED_PERCENTAGE_WITH_OVERLIMIT_AND_OVERDUE_AMOUNT` = 2. For more information, refer to [Minimum amount due calculation](doc:minimum-amount-due-calculation#full-amount-transactions). **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Register revolving statement summary generation process](https://developers.pismo.io/pismo-docs/reference/postrevolvingstatementsummary.md): Registers a record with `PENDING` status to start the revolving statement summary generation process. When the process completes, it generates a [Revolving statement summary](https://developers.pismo.io/events/docs/balance-revolving-statement-summary-1) event containing the summary. - [Shift transactions](https://developers.pismo.io/pismo-docs/reference/post-shift-transactions.md): Shift one or more transactions between open statements. For example, a transaction can be moved from a future statement to an earlier open statement. A transaction can also be moved to a statement farther in the future. A maximum of 24 shifts are allowed per request. This endpoint generates an [Transaction updated](https://developers.pismo.io/events/docs/transaction-update-1) event for each transaction that is shifted. After all the transactions are successfully shifted, it generates a [Transactions shifted](https://developers.pismo.io/events/docs/balance-shift-transactions-1) event. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [Get transaction shift](https://developers.pismo.io/pismo-docs/reference/gettransactionshift.md): Get the record for a performed shift. Includes the IDs for the source and destination statements. **Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message. - [List multivalue program parameter values](https://developers.pismo.io/pismo-docs/reference/getprogramparameter.md): Retrieve an array of multivalue program parameter values given a parameter ID and program ID. For a list of available multivalue parameters, refer to [Multivalue program parameters](doc:multivalue-parameters). - [Update multivalue program parameter values](https://developers.pismo.io/pismo-docs/reference/updateprogramparamenter.md): Update multivalue program parameters using an array list. For a list of available multivalue parameters, refer to [Multivalue program parameters](doc:multivalue-parameters). - [Delete multivalue program parameter values](https://developers.pismo.io/pismo-docs/reference/deleteprogramparamenter.md): Delete multivalue program parameter values. For a list of available multivalue parameters, refer to [Multivalue program parameters](doc:multivalue-parameters). - [Update program transaction type](https://developers.pismo.io/pismo-docs/reference/updateprogramtransactiontype.md): Update a program transaction type. - [List program transaction types](https://developers.pismo.io/pismo-docs/reference/gettransactiontypes_1.md): List a program's transaction types with filtering options. - [List transaction types ](https://developers.pismo.io/pismo-docs/reference/gettransactiontypes.md): List transaction types. This endpoint will be **DEPRECATED**. Use [List program transaction types](ref:gettransactiontypes_1) instead. - [List account timeline events](https://developers.pismo.io/pismo-docs/reference/list-timeline-events.md): List the events in an account timeline using cursor pagination. - [Create merchant](https://developers.pismo.io/pismo-docs/reference/createmerchant.md): Create merchant. You use this endpoint to register a merchant (store) in a marketplace using the information the merchant provides. Note: Before you create merchants, you must create a Merchant program, using the [Create program based on template](ref:createprogrambasedontemplate) endpoint with `type` set to `MERCHANT`. If a program of type `MERCHANT` is not provided, the request returns an error. By default, when a merchant is created, the Pismo platform assigns it to the first existing program of type `MERCHANT` in the Org. However, you have the option of specifying a program by providing its ID in the `program_id` field. Note: When a `x-marketplace-id` header is provided, the merchant is automatically linked to the provided marketplace after creation. For more information about merchants, refer to the Seller management overview guide.
This endpoint generates a [Merchant created](https://developers.pismo.io/events/docs/merchants-merchant-created-1) event. - [List merchants](https://developers.pismo.io/pismo-docs/reference/listmerchants.md): Find merchants using query parameters. For more information about merchants, see the Seller management overview guide. - [Get merchant](https://developers.pismo.io/pismo-docs/reference/getmerchant.md): Get merchant by ID. For more information about merchants, see the Seller management overview guide. - [Update merchant](https://developers.pismo.io/pismo-docs/reference/updatemerchant.md): Update merchant by ID. For more information about merchants, see the Seller management overview guide.
This endpoint generates a [Merchant updated](https://developers.pismo.io/events/docs/merchants-merchant-updated-1) event. - [List status transitions](https://developers.pismo.io/pismo-docs/reference/liststatustransitions.md): List the status transitions using the merchant ID. - [Update merchant status](https://developers.pismo.io/pismo-docs/reference/updatemerchantstatus.md): Update merchant status using the merchant ID. To find all available merchant status transitions, use [List status transitions](ref:liststatustransitions). This endpoint generates a [Merchant updated](https://developers.pismo.io/events/docs/merchants-merchant-updated-1) event. - [List creditors](https://developers.pismo.io/pismo-docs/reference/listcreditors.md): List creditors using query parameters. - [Get creditor](https://developers.pismo.io/pismo-docs/reference/getcreditor.md): Get creditor by ID. - [Update creditor](https://developers.pismo.io/pismo-docs/reference/updatecreditor.md): Update creditor using its ID. This endpoint generates a [Marketplace creditor operation updated](https://developers.pismo.io/events/docs/marketplace-marketplace-creditor-operation-updated-1) event. - [List merchant transactions by operations](https://developers.pismo.io/pismo-docs/reference/listmerchattransactionsbyoperationsv3.md): List merchant transactions grouped by Org operations. Returns one item for each Org operation that has transactions for the specified date. An item lists the amounts (gross, net, and discount) for that operation. - [List merchant transactions (V2)](https://developers.pismo.io/pismo-docs/reference/listmerchanttransactionsv2.md): List merchants transactions filtered using query parameters. NOTE: By default, the endpoint returns only 60 days of merchant transactions. If you want a longer period (up to 365 days), you must provide the `saleAuthorizationId` parameter, and specify a desired date in both `startEventDate` and `endEventDate`. - [List merchant transactions (V3)](https://developers.pismo.io/pismo-docs/reference/listmerchanttransactionsv3.md): List merchant transactions filtered using query parameters. - [Get merchant transaction](https://developers.pismo.io/pismo-docs/reference/getmerchanttransactionv2.md): Get transaction details using merchant transaction ID - [List merchant taxes](https://developers.pismo.io/pismo-docs/reference/listmerchanttaxes.md): List taxes for merchant by merchant ID. - [Get transactions summary](https://developers.pismo.io/pismo-docs/reference/gettransactionssummary.md): Get a summary of a merchant's transactions. - [Get transactions summary [beta]](https://developers.pismo.io/pismo-docs/reference/gettransactionssummaryv2.md): Returns the transactions totals summarized by status and/or date. When the `groupBy` is provided with the values `date` or `dateAndStatus` the date range between `startPaymentDate` and `endPaymentDate` must not exceed 30 days. - [Get transaction types](https://developers.pismo.io/pismo-docs/reference/getreportformerchanttransactiontypesv3.md): Get transactions types. Examples of transaction types include cash-in and cash-out. See Transaction types for the list of transaction types on the Pismo platform. - [Get transaction details (deprecated)](https://developers.pismo.io/pismo-docs/reference/gettransactiondetails.md): Get details for specific transaction - [Update transaction status](https://developers.pismo.io/pismo-docs/reference/updatetransactionstatus.md): Update transaction status. - [List business categories](https://developers.pismo.io/pismo-docs/reference/listbusinesscategories.md): Retrieves the list of business categories for merchants. - [Get business category](https://developers.pismo.io/pismo-docs/reference/getbusinesscategory.md): Get business category using external code. The category is the type of business. - [Create advancement request (outdated)](https://developers.pismo.io/pismo-docs/reference/createadvancementrequestformerchant.md): Create advancement request for merchant. An advancement is the same as an anticipation of receivables or a prepayment of receivables. An example of a situation in which a seller might use advancements is if it has a deal with a large customer who it knows is going to take some time to pay its bills. To cover its business expenses in the meantime, the seller could make a deal with a bank to pay it for the goods sold at the time of sale. The seller later repays the bank when it gets paid by its customer. The bank profits because the seller pays a fee for each advancement.
This endpoint produces a [Merchant advancement request created](https://developers.pismo.io/events/docs/merchants-advancement-request-1) event. (Outdated: For an updated version of the advancement endpoint refer to [Advancement Request](https://developers.pismo.io/pismo-docs/reference/merchants-advancements).) - [List advancements for merchant (outdated)](https://developers.pismo.io/pismo-docs/reference/listadvancementsformerchant.md): List advancements for merchant by merchant ID. A merchant advancement is sometimes called a prepayment of receivables. You arrange to have a financial institution make regular deposits into your account equal to what you expect to receive in the future from credit card sales in installments or post-dated checks and bills. The financial institution deducts its fee before it puts the money in your account. You pay back each deposit when you receive payment from your customers. This is a way of covering business expenses in the short term. It's a cheaper alternative to a loan. (Outdated: For an updated version of the future merchant schedule refer to [List Transactions](https://developers.pismo.io/pismo-docs/reference/merchants-transactions).) - [List advancement requests](https://developers.pismo.io/pismo-docs/reference/listadvancementrequestsformerchant.md): List advancements requested by merchant. An advancement is the same as a receivable or a prepayment of a receivable. An example of a situation in which a seller might use advancements is if it has a deal with a large customer who it knows is going to take some time to pay its bills. To cover its business expenses in the meantime, the seller could make a deal with a bank to pay it for the goods sold at the time of sale. The seller later repays the bank when it gets paid by its customer. The bank profits because the seller pays a fee for each advancement. - [Get advancement request (outdated)](https://developers.pismo.io/pismo-docs/reference/getadvancementrequest.md): Get an advancement request using an advancement request ID and a merchant ID. An advancement is the same as a receivable or a prepayment of a receivable. An example of a situation in which a seller might use advancements is if it has a deal with a large customer who it knows is going to take some time to pay its bills. To cover its business expenses in the meantime, the seller could make a deal with a bank to pay it for the goods sold at the time of sale. The seller later repays the bank when it gets paid by its customer. The bank profits because the seller pays a fee for each advancement. (Outdated: For an updated version of the get advancement request endpoint refer to [Get Advancement](https://developers.pismo.io/pismo-docs/reference/merchants-advancements-data).) - [Simulate merchant advancement](https://developers.pismo.io/pismo-docs/reference/merchants-advancements.md): Create or simulate a merchant advancement request. To trigger a simulated advancement request, you must include `confirmAdvancement=false` in the query. If you specify `true`, the advancement request becomes an actual request, not a simulation.
The endpoint enables a merchant to simulate an advancement scenario in order to validate whether or not there is enough balance in the account, as well as how much tax is anticipated. Since a simulated advancement is not a real advancement, it is not processed. A merchant advancement is sometimes called a prepayment of receivables. You arrange to have a financial institution make regular deposits into your account equal to what you expect to receive in the future from credit card sales in installments or post-dated checks and bills. The financial institution deducts its fee before it puts the money in your account. You pay back each deposit when you receive payment from your customers. This is a way of covering business expenses in the short term. It's a cheaper alternative to a loan.
Note: - If the merchant is the head merchant (also called a centralizer), the advanced amount is given to the head merchant instead of individual branch merchants, this is designed for better manageability. - If the commercial establishment is not registered as a headquarter or a branch in the current marketplace, the advancement is for a single commercial establishment. - The merchant must have sufficient balance in the account for the specified date range of the advancement. This endpoint generates a [Merchant advancement request created](https://developers.pismo.io/events/docs/merchants-advancement-request-1) event. - [Simulate transaction advancement](https://developers.pismo.io/pismo-docs/reference/merchant-transaction-advancement.md): Create or simulate a merchant advancement request for specified transactions. You can select which transaction you want to advance by specifying a merchant transaction ID. To trigger a simulated advancement request, you must include `confirmAdvancement=false` in the query string. If you specify `true`, the advancement request becomes an actual request, not a simulation.
When a merchant advancement transaction is created, the endpoint produces [Merchant transaction created](https://developers.pismo.io/events/docs/merchants-merchant-transaction-created-1) and [Merchant advancement transaction created](https://developers.pismo.io/events/docs/merchants-advancement-transaction-create-1) events. - [Get advancement](https://developers.pismo.io/pismo-docs/reference/merchants-advancements-data.md): Return information about an existing advancement. It returns fields such as dates, values, or status. If the advancement is only simulated but not yet in effect, the endpoint does not return any information. - [List transactions](https://developers.pismo.io/pismo-docs/reference/merchants-transactions.md): Search for the balance of future schedules, consolidated by expected settlement date. In a head (centralizing) and branch (centralized) scenario, the transaction sum from all merchant branches is listed. - [Block merchants for settlement](https://developers.pismo.io/pismo-docs/reference/blockmerchantsforsettlement.md): Block merchants for settlement. Designates merchants that should be skipped in the settlement process. - [Unblock merchants for settlement](https://developers.pismo.io/pismo-docs/reference/unblockmerchantsforsettlement.md): Unblock merchants that were previously blocked using the [Block merchants for settlement](ref:blockmerchantsforsettlement) endpoint. Unblocked merchants are no longer skipped in the settlement process. - [Get blocked merchants](https://developers.pismo.io/pismo-docs/reference/getblockedmerchants.md): Retrieve merchants that were previously blocked using the [Block merchants for settlement](ref:blockmerchantsforsettlement) endpoint. - [Run settlement](https://developers.pismo.io/pismo-docs/reference/runsettlement.md): Start the settlement process for a specified merchant. - [List advancement requests settled](https://developers.pismo.io/pismo-docs/reference/getadvancementsbysettlement.md): List advancement requests settled per merchant using a tracking_id. - [Create marketplace V3](https://developers.pismo.io/pismo-docs/reference/createmarketplace.md): This endpoint creates a new marketplace. This endpoint generates a Marketplace created event. - [List marketplaces](https://developers.pismo.io/pismo-docs/reference/getmarketplaces.md): Retrieve a paginated list of marketplaces with optional filtering and sorting capabilities. ## Filtering Filters are provided as individual query parameters. Multiple filters can be combined — each additional parameter further restricts the result set (AND logic). | Parameter | Field Filtered | Match Type | Case Sensitive | |---|---|---|---| | `documentNumber` | `document_number` | Exact | Yes | | `externalId` | `external_id` | Exact | Yes | | `brandName` | `brand_name` | Partial (LIKE) | No | | `marketplaceName` | `marketplace_name` | Partial (LIKE) | No | **Examples:** - `?documentNumber=12345678901234` — exact document number match - `?brandName=Acme` — brand name containing "Acme" - `?brandName=Acme&marketplaceName=Store` — brand name containing "Acme" AND marketplace name containing "Store" ## Sorting Use `order` and `orderBy` to control result ordering. Supported `orderBy` values: `marketplace_id`, `document_number`, `brand_name`, `marketplace_name`, `external_id`. Default sort: `marketplace_id ASC`. ## Empty Results Empty result sets return **HTTP 200** with an empty `items` array (not 404). - [Get marketplace by ID](https://developers.pismo.io/pismo-docs/reference/getmarketplacebyid.md): Retrieve marketplace information by its ID. Returns detailed information about a specific marketplace including its configuration, contact details, and address information. - [Update marketplace](https://developers.pismo.io/pismo-docs/reference/updatemarketplace.md): This endpoint updates the marketplace information. This endpoint generates a Marketplace updated event. - [Link marketplace to merchants](https://developers.pismo.io/pismo-docs/reference/createmarketplacemerchantslink.md): Link marketplace with a list of merchants. - [List merchants linked to a marketplace](https://developers.pismo.io/pismo-docs/reference/listmarketplacemerchantslinked.md): Returns information about the merchants linked to this marketplace - [Unlink marketplace and merchant](https://developers.pismo.io/pismo-docs/reference/deletemarketplacemerchantlink.md): Delete link between marketplace and merchant. - [Create split request](https://developers.pismo.io/pismo-docs/reference/post-split-request.md): Create a new split request for a merchant transaction.
Managing financial transactions often requires dividing a single transaction into multiple parts for accurate record-keeping and reporting. The split transaction feature addresses this need by allowing you to split a transaction into different categories or assign portions to various accounts. This functionality is particularly useful for handling shared expenses, allocating costs across different budget categories, or separating business and personal expenses. When a split request is created, it's created with a `PENDING` status. Before you request a split, make sure the merchant transaction is already in the `WAITING_SPLIT` status.
This endpoint generates a [Merchant transaction created](https://developers.pismo.io/events/docs/merchants-merchant-transaction-created-1) event. - [Cancel split request](https://developers.pismo.io/pismo-docs/reference/cancel-split-request.md): Cancel a merchant transaction split request.
This endpoint generates a [Merchant transaction created](https://developers.pismo.io/events/docs/merchants-merchant-transaction-created-1) event. - [List split requests](https://developers.pismo.io/pismo-docs/reference/get-split-requests.md): List split requests for a given marketplace. - [Get split request details](https://developers.pismo.io/pismo-docs/reference/get-split-details.md): Get the details of a specific split request in a marketplace. - [Get split request totals](https://developers.pismo.io/pismo-docs/reference/get-sale-split-request-totals.md): Get the total amount for a specific split request in a marketplace.
This endpoint returns the gross amount for a specific parent split request with the `PROCESSED` status. It also return the gross amount for each participating merchant, as well as marketplace merchants. - [Get merchant balance](https://developers.pismo.io/pismo-docs/reference/get-merchant-balance.md): The merchant balance endpoint provides an estimate of the available funds in the merchant account on a specified target date. It takes into account the scheduled merchant transactions in the specified marketplace to calculate the estimated values. `estimated_available_amount` represents the forecasted amount that might be available to the merchant on the target date, based on the current scheduled transactions. This estimate is subject to change due to cancellations, new transactions, and advancements made by the merchant until the target date arrives. If the merchant's scheduled balance is negative, the amount accumulates in the `scheduled_amount` field until it becomes positive and is available for settlement. Therefore, a negative `scheduled_amount` is not considered for settlement until it turns positive. - [Create merchant transaction](https://developers.pismo.io/pismo-docs/reference/post-merchant-transaction-sale.md): Create a new merchant transaction (sale) for a specific merchant associated with a marketplace. This endpoint allows for the creation of merchant sale transactions with installment support, MDR calculations, and scheduled payment dates. The default status is `SCHEDULED`. However, if the merchant is a marketplace scheduler, the transaction will automatically be set to `WAITING_SPLIT` status. This endpoint generates a [Merchant transaction created](https://developers.pismo.io/events/docs/merchants-merchant-transaction-created-1) event. - [Cancel merchant transaction](https://developers.pismo.io/pismo-docs/reference/post-merchant-transaction-cancel.md): Cancel a previously created merchant transaction. This endpoint allows for the creation of cancellation transactions that reverse the financial impact of original sale transactions. Cancellation transactions maintain negative amounts of all financial values (amount, MDR, fees) and reference the original transaction via origin_merchant_transaction_id. When the original transaction was split, the cancellation status is automatically set to `WAITING_SPLIT`, otherwise it follows the default status (`SCHEDULED`). This endpoint generates a [Merchant transaction created](https://developers.pismo.io/events/docs/merchants-merchant-transaction-created-1) event. - [Create marketplace V2 (deprecated)](https://developers.pismo.io/pismo-docs/reference/postmarketplacesv2.md): This endpoint creates a marketplace asynchronously, which means that you need to wait for the [Marketplace created](https://developers.pismo.io/events/docs/marketplace-marketplace-created-1) event before calling other endpoints that reference the new marketplace. Use this endpoint to create marketplaces that will later be linked to merchants created with the [Create merchant](ref:createmerchant) endpoint. For more information about marketplaces, refer to the [Seller management overview](doc:seller-management-overview) guide. This endpoint generates a [Marketplace created](https://developers.pismo.io/events/docs/marketplace-marketplace-created-1) event. This endpoint creates a merchant asynchronously [Merchant Creation](https://developers.pismo.io/pismo-docs/reference/createmerchant). This endpoint is **deprecated**. It is replaced by [Create marketplace V3](https://developers.pismo.io/pismo-docs/reference/createmarketplace). - [Get marketplace](https://developers.pismo.io/pismo-docs/reference/getmarketplacebyidv2.md): Get marketplace given its ID in the path. - [Update marketplace (deprecated)](https://developers.pismo.io/pismo-docs/reference/putupdatemarketplacev1.md): Update a marketplace given its ID in the path. This endpoint generates a [Marketplace updated](https://developers.pismo.io/events/docs/marketplace-marketplace-updated-1) event. This endpoint is **deprecated**. It is replaced by [Update marketplace](https://developers.pismo.io/pismo-docs/reference/updatemarketplace). - [Get marketplace (deprecated)](https://developers.pismo.io/pismo-docs/reference/getmarketplacebyidv1.md): This endpoint gets a marketplace by ID. This endpoint is **deprecated**. It is replaced by [Get marketplace](https://developers.pismo.io/pismo-docs/reference/getmarketplacebyid). - [Create marketplace V1 (deprecated)](https://developers.pismo.io/pismo-docs/reference/postmarketplacesv1.md): This endpoint creates a marketplace. This endpoint is **deprecated**. It is replaced by [Create marketplace V3](https://developers.pismo.io/pismo-docs/reference/createmarketplace). - [List marketplaces (deprecated)](https://developers.pismo.io/pismo-docs/reference/getmarketplacesv1.md): List marketplaces using query parameters. This endpoint is **deprecated**. It is replaced by [List marketplaces](https://developers.pismo.io/pismo-docs/reference/getmarketplaces). - [List marketplace creditor operations](https://developers.pismo.io/pismo-docs/reference/getcreditorsoperationsv2.md): List creditor operations for the specified marketplace. - [Create marketplace creditor operations](https://developers.pismo.io/pismo-docs/reference/postcreditorsoperationsv2.md): Create multiple creditor operations for the specified marketplace. This endpoint creates one creditor operation for each merchant ID and each installment in the request body. The values of `processing_code` and `start_date` are replicated to each creditor operation created based on the installments configuration. This endpoint generates [Marketplace creditor operation created](https://developers.pismo.io/events/docs/marketplace-marketplace-creditor-operation-created-1) events. - [Update creditor operations](https://developers.pismo.io/pismo-docs/reference/putcreditorsoperationsv2.md): Update fields for all creditor operations that match a provided filter criteria: `processing_code`, `start_date`, or `installments`. This endpoint generates [Marketplace creditor operation updated](https://developers.pismo.io/events/docs/marketplace-marketplace-creditor-operation-updated-1) events. - [Create creditor operation](https://developers.pismo.io/pismo-docs/reference/postcreditorsoperations.md): Create a creditor operation. This endpoint generates a [Marketplace creditor operation created](https://developers.pismo.io/events/docs/marketplace-marketplace-creditor-operation-created-1) event. - [Patch creditor operation](https://developers.pismo.io/pismo-docs/reference/patchcreditoroperationbyidv1.md): Update creditor operation fields using marketplace and creditor IDs. This endpoint generates a [Marketplace creditor operation updated](https://developers.pismo.io/events/docs/marketplace-marketplace-creditor-operation-updated-1) event. - [Get creditor operation](https://developers.pismo.io/pismo-docs/reference/getcreditoroperationbyid.md): Get creditor operation information using marketplace and creditor IDs. - [Update creditor operation](https://developers.pismo.io/pismo-docs/reference/putupdatecreditoroperationbyid.md): Update creditor operation information using marketplace and creditor IDs. This endpoint generates a [Marketplace creditor operation updated](https://developers.pismo.io/events/docs/marketplace-marketplace-creditor-operation-updated-1) event. - [Delete creditor operation](https://developers.pismo.io/pismo-docs/reference/deletecreditoroperationbyid.md): Delete creditor operation by ID. This endpoint generates a [Marketplace creditor operation deleted](https://developers.pismo.io/events/docs/marketplace-marketplace-creditor-operation-deleted-1) event. - [List creditor operations for marketplace and merchant](https://developers.pismo.io/pismo-docs/reference/getcreditoroperationsbymerchantidandmarketplaceid.md): List creditor operations using marketplace and merchant IDs. - [List merchant creditors](https://developers.pismo.io/pismo-docs/reference/getmerchantscreditorsv1.md): List creditors for the merchants in a marketplace. - [Create MDR tax information](https://developers.pismo.io/pismo-docs/reference/postmdrtaxv1.md): Store information about Merchant Discount Rate (MDR) tax using marketplace ID. The MDR is the rate charged to a merchant for payment processing services on debit and credit card transactions. The merchant must set up this service and agree to the rate before accepting debit and credit cards as payment. For information about MDR, refer to the Merchant Discount Rate. - [Get MDR tax information](https://developers.pismo.io/pismo-docs/reference/getmdrtaxbyidv1.md): Get Merchant Discount Rate (MDR) tax information using marketplace ID. - [Delete MDR tax information](https://developers.pismo.io/pismo-docs/reference/deletemdrtaxv1.md): Delete Merchant Discount Rate (MDR) tax information using marketplace ID. - [List marketplace merchants V2 (deprecated)](https://developers.pismo.io/pismo-docs/reference/getmerchantsbymarketplaceidv2.md): List merchants linked to the specified marketplace. This endpoint is **deprecated**. It is replaced by [List marketplace merchants](https://developers.pismo.io/pismo-docs/reference/listmarketplacemerchantslinked). - [List marketplace merchants V1 (deprecated)](https://developers.pismo.io/pismo-docs/reference/getmerchantsbymarketplaceidv1.md): List merchants for specified marketplace. This endpoint is **deprecated**. It is replaced by [List marketplace merchants](https://developers.pismo.io/pismo-docs/reference/listmarketplacemerchantslinked). - [Link merchant and marketplace (deprecated)](https://developers.pismo.io/pismo-docs/reference/postlinkmerchanttomarketplacev1.md): Link merchant to marketplace. This endpoint is **deprecated**. It is replaced by [Link marketplace to merchants](https://developers.pismo.io/pismo-docs/reference/createmarketplacemerchantslink). - [Delete merchant and marketplace link (deprecated)](https://developers.pismo.io/pismo-docs/reference/deletelinkbetweenmerchantandmarketplacev1.md): Unlink merchant and marketplace. This endpoint is **deprecated**. It is replaced by [Unlink marketplace and merchant](https://developers.pismo.io/pismo-docs/reference/deletemarketplacemerchantlink). - [Migrate accounts](https://developers.pismo.io/pismo-docs/reference/postaccountsv2.md): Start accounts migration (v2). **Note:** This endpoint replaces the Migrate accounts (v1) endpoint. This endpoint generates the following events: - [Account migration started](https://developers.pismo.io/events/docs/migration-account-incoming-2) - [Account migration completed ](https://developers.pismo.io/events/docs/migration-account-outgoing-2) - [Migrate accounts Go-live](https://developers.pismo.io/pismo-docs/reference/postgolivev1.md): **Go-live** is a process that happens at the end of a migration. After migrating accounts, you must call the Go-live endpoint to mark all migrated accounts active. The Pismo platform responds by changing the migration status of each account to `MIGRATED`. This endpoint generates an [Account go-live completed](https://developers.pismo.io/events/docs/migration-account-go-live-outgoing-1) event. Each unique go-live request generates _N_ events (one for each account that has the specified migration phase ID) with a different x-cid from the initial request. - [Migrate accounts pre go-live](https://developers.pismo.io/pismo-docs/reference/postpregolivev1.md): Pre Go-live enables you to preview the results of the Go-live process without actually implementing them. It performs a series of actions for every account assigned to a specific phase ID. For more information, refer to the [Migrations overview](doc:migrations-overview) guide. **Note:** Pre Go-live is **REQUIRED** for migrating credit accounts but optional for other account types. This endpoint generates the following events (one for every migrated account): - [Pre Go-live migration completed](https://developers.pismo.io/events/docs/migration-account-pre-go-live-outgoing-1) – when the Pre Go-live process finishes and the result is reported (SUCCESS or FAIL). - [Pre-Go-live migration error](https://developers.pismo.io/events/docs/migration-pre-go-live-outgoing-1) – when the Pre Go-live process runs but errors occur before dispatching the SUCCESS/FAIL event for each migrated account. - [Migrate accruals](https://developers.pismo.io/pismo-docs/reference/postaccrualsv1.md): Start accruals migration. This endpoint generates the following events: - [Accrual migration started](https://developers.pismo.io/events/docs/migration-accrual-incoming-1) - [Accrual migration completed](https://developers.pismo.io/events/docs/migration-accrual-outgoing-1) - [Migrate authorizations](https://developers.pismo.io/pismo-docs/reference/postauthorizationsv1.md): Start authorizations migration. This endpoint generates the following events: - [Authorization migration started](https://developers.pismo.io/events/docs/migration-authorization-incoming-1) - [Authorization migration completed](https://developers.pismo.io/events/docs/migration-authorization-outgoing-1) - [Migrate balances](https://developers.pismo.io/pismo-docs/reference/postbalancecontrolv1.md): This endpoint enables you to migrate balances from your legacy platform to the Pismo platform — after statement migration but only before Go-live. This allows the platform to calculate retroactive accruals even if you did not perform daily accruals on your legacy platform. You also may split balances to indicate which ones are accruable and fineable. When migrating balances, all transaction types must be configured. Refer to [Setting transaction types to block accrual charges](https://developers.pismo.io/pismo-docs/docs/configuring-transaction-types-to-not-accrue-charges) for more information. This endpoint generates the following events: - [Balance control migration started](https://developers.pismo.io/events/docs/migration-balance-control-incoming-1) - [Balance control migration completed](https://developers.pismo.io/events/docs/migration-balance-control-outgoing-1) - [Migrate cards](https://developers.pismo.io/pismo-docs/reference/postcardsv1.md): Start migration of non-PCI cards. This endpoint generates the following events: - [Card migration started](https://developers.pismo.io/events/docs/migration-card-incoming-1) - [Card migration completed](https://developers.pismo.io/events/docs/migration-card-outgoing-1) - For COMBO card migrations (that is, `mode = COMBO` and `combo_account_id = NOT NULL`), a third event is also sent: [Combo card mode migration completed](https://developers.pismo.io/events/docs/migration-card-mode-outgoing-1). This applies to the initial card migration only, but not to updates made before Go-live. - [Migrate PCI cards](https://developers.pismo.io/pismo-docs/reference/postpcicardsv1.md): Start migrations of PCI cards. This endpoint generates the [PCI card migration completed](https://developers.pismo.io/events/docs/migration-pci-card-outgoing-1) event. The result is either `SUCCESS` or `FAIL`. **Note:** This is a PCI endpoint. Use the https://gw-pci.pismolabs.io environment. - [Migrate customers](https://developers.pismo.io/pismo-docs/reference/postcustomersv1.md): Start customer migration. Use this endpoint to migrate additional customers after an account is migrated using the [Migrate accounts endpoint](ref:postaccountsv2). This endpoint produces the following events: - [Customer migration started](https://developers.pismo.io/events/docs/migration-customer-incoming-1) - [Customer migration completed](https://developers.pismo.io/events/docs/migration-customer-outgoing-1) - [Migrate disputes](https://developers.pismo.io/pismo-docs/reference/postdisputev1.md): Starts the migration of a dispute - [Start migration of delinquency buckets](https://developers.pismo.io/pismo-docs/reference/postdelinquencybucketv1.md): Migrate delinquency buckets - [Migrate account fee models](https://developers.pismo.io/pismo-docs/reference/postfeemodelv1.md): Start migration of **fee models** that are [linked to customer accounts](ref:attachmentbyaccount). (A [fee model](doc:fee-model) links a collection of fees to an account.) This endpoint generates the following events: - [Fee model account migration started](https://developers.pismo.io/events/docs/migration-fee-model-account-incoming-1) - [Fee model account migration completed](https://developers.pismo.io/events/docs/migration-fee-model-account-outgoing-1) - [Migrate merchants](https://developers.pismo.io/pismo-docs/reference/postmerchantsv1.md): Start migration of merchant details, such as marketplace ID, brand name, contact and creditor information. This endpoint generates the following events: - [Merchant migration started](https://developers.pismo.io/events/docs/migration-merchant-incoming-1) - [Merchant migration completed](https://developers.pismo.io/events/docs/migration-merchant-outgoing-1) - [Migrate merchant transactions](https://developers.pismo.io/pismo-docs/reference/postmerchanttransactionsv1.md): Start migration of Merchant transaction details such as authorization ID, merchant ID, marketplace ID, and so on. This endpoint generates the following events: - [Merchant Transaction migration started](https://developers.pismo.io/events/docs/migration-merchant-transaction-incoming-1) - [Merchant transactions migration completed](https://developers.pismo.io/events/docs/migration-merchant-transaction-outgoing-1) - [Migrate on-us authorizations](https://developers.pismo.io/pismo-docs/reference/postonusauthorizationsv1.md): Start migration of **on-us authorizations** to the Pismo platform. (An on-us authorization is one that Pismo processes without involving card networks, such as Mastercard or Visa). This endpoint generates the following events: - [On-us authorization migration started](https://developers.pismo.io/events/docs/migration-on-us-authorization-incoming-1) - [On-us authorization migration completed](https://developers.pismo.io/events/docs/migration-on-us-authorization-outgoing-1) - [Migrate statements](https://developers.pismo.io/pismo-docs/reference/poststatementsv1.md): Start migration of statements. This endpoint generates the following events: - [Statement migration started](https://developers.pismo.io/events/docs/migration-statement-incoming-1) - [Statement migration completed](https://developers.pismo.io/events/docs/migration-statement-outgoing-1) - [Migrate tokens](https://developers.pismo.io/pismo-docs/reference/posttokensv1.md): Start migration of tokens. This endpoint generates the following events: - [Token migration started](https://developers.pismo.io/events/docs/migration-token-incoming-1) - [Token migration completed](https://developers.pismo.io/events/docs/migration-token-outgoing-1) - [Migrate transactions](https://developers.pismo.io/pismo-docs/reference/posttransactionsv1.md): Start migration of transactions. This endpoint generates the following events: - [Transaction migration started](https://developers.pismo.io/events/docs/migration-transaction-incoming-1) - [Transaction migration completed](https://developers.pismo.io/events/docs/migration-transaction-outgoing-1) - [Payment agreements migration completed](https://developers.pismo.io/events/docs/migration-payment-agreements-outgoing-1) (generated when the migration has the `payment_agreement` field set to `true`) - [Instant payment transaction migration completed](https://developers.pismo.io/events/docs/migration-instant-payment-outgoing-1) (generated when migration.type is `INSTANT_PAYMENT`) - [Migrate recurring charge plans](https://developers.pismo.io/pismo-docs/reference/postrecurringchargeplansv1.md): Start migration of **recurring charge plans**. (A recurring charge plan defines a recurring charge such as an annual fee, which is applied on a fixed schedule, and the number of installments [cycles] to which the charge should be applied.) This endpoint generates the following events: - [Recurring Charge plan migration started](https://developers.pismo.io/events/docs/migration-recurring-charge-plan-incoming-1) - [Recurring charge plan migration completed](https://developers.pismo.io/events/docs/migration-recurring-charge-plan-outgoing-1) - [Migrate recurring charge links](https://developers.pismo.io/pismo-docs/reference/postrecurringchargelinksv1.md): Start migration of **recurring charge links** for an account. (A recurring charge link associates an active recurring charge plan with an account, so that the charges defined for the plan are applied to the account.) This endpoint generates the following events: - [Recurring Charge link migration started](https://developers.pismo.io/events/docs/migration-recurring-charge-link-incoming-1) - [Recurring charge link migration completed](https://developers.pismo.io/events/docs/migration-recurring-charge-link-outgoing-1) (one event for **each item** in the `links` array in the payload) - [Get loan product](https://developers.pismo.io/pismo-docs/reference/getloanproductv2.md): Get a loan product by its ID. - [Update loan product](https://developers.pismo.io/pismo-docs/reference/updateloanproductv2.md): Update an existing loan product with only the fields that are passed in the request body. This endpoint generates a [Loan product updated](https://developers.pismo.io/events/docs/lending-loan-product-update-1) event. - [Delete loan product](https://developers.pismo.io/pismo-docs/reference/deleteloanproductv2.md): Delete a loan product by its ID. This operation marks the loan product as deleted and it cannot be used for new loans. This endpoint generates a [Loan product updated](https://developers.pismo.io/events/docs/lending-loan-product-update-1) event. - [Create loan product](https://developers.pismo.io/pismo-docs/reference/createloanproductv2.md): Creates a loan product. This endpoint generates a [Loan product created](https://developers.pismo.io/events/docs/lending-loan-product-creation-3) event. - [List loan products](https://developers.pismo.io/pismo-docs/reference/getloanproductsv2.md): List loan products. - [List account loans](https://developers.pismo.io/pismo-docs/reference/getloansbyaccountidv2.md): Retrieve all loans associated with the specified account. **Note**: This endpoint requires an [account-specific access token](ref:get-an-account-specific-token-basic-authentication). - [Create loan adjustment](https://developers.pismo.io/pismo-docs/reference/createloanadjustmentv2.md): Create loan adjustment - [Book loan](https://developers.pismo.io/pismo-docs/reference/bookloanv2.md): Books a loan with the configuration set up in the loan product. This endpoint generates a [Loan booked](https://developers.pismo.io/events/docs/lending-loan-booked-1) event and a [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1) event. - [List loans](https://developers.pismo.io/pismo-docs/reference/retrievepaginatedloans.md): List loans - [Get loan](https://developers.pismo.io/pismo-docs/reference/getloanv2.md): Get a loan by its ID. - [Cancel loan](https://developers.pismo.io/pismo-docs/reference/cancelloanv2.md): Cancels a loan. This endpoint generates a [Loan updated](https://developers.pismo.io/events/docs/lending-lending-loan-update-1) event. - [Restructure a loan](https://developers.pismo.io/pismo-docs/reference/restructureloan.md): Restructures an existing loan based on provided details. - [Cancel all loans by account](https://developers.pismo.io/pismo-docs/reference/cancelallloansbyaccountv2.md): Cancels all active loans for the specified account **Note**: This endpoint requires an [account-specific access token](ref:get-an-account-specific-token-basic-authentication). This endpoint generates [Loan updated](https://developers.pismo.io/events/docs/lending-lending-loan-update-1) events for each cancelled loan. - [Disburse loan](https://developers.pismo.io/pismo-docs/reference/disburseloanv2.md): Disburse a loan. - [Register repayment](https://developers.pismo.io/pismo-docs/reference/registerrepaymentv2.md): Registers a repayment for the specified loan ID. - [Simulate early final settlement](https://developers.pismo.io/pismo-docs/reference/simulateearlyfinalsettlementv2.md): Simulate an early final settlement (EFS) for a loan. Optionally calculate present value with a future reference date - [Register early final settlement](https://developers.pismo.io/pismo-docs/reference/registerearlyfinalsettlementv2.md): Register an early final settlement (EFS) for a loan using a previously simulated EFS ID. - [Simulate prepayment](https://developers.pismo.io/pismo-docs/reference/simulateprepaymentv2.md): Simulate a prepayment for a loan using the prepayment engine. The response includes the resulting balance breakdown, the new repayment schedule, and a `simulation_id` that can later be used to register the prepayment via `POST /v2/loans/{loanId}/prepayment/{simulationId}/register`. This endpoint generates a [Lending prepayment creation](https://developers.pismo.io/events/docs/lending-lending-prepayment-v2-creation-1) event. - [Register prepayment simulation](https://developers.pismo.io/pismo-docs/reference/registerprepaymentsimulationv2.md): Register a previously calculated prepayment simulation, applying it to the loan. The request body is optional and is only used to override the processing codes used to record the prepayment, penalty, and insurance movements in the prepayment workflow. This endpoint generates a [Lending prepayment status changed](https://developers.pismo.io/events/docs/lending-lending-prepayment-v2-status-changed-1) event. - [Create prepayment record](https://developers.pismo.io/pismo-docs/reference/createprepayment.md): Creates a prepayment record containing one or multiple repayments. This endpoint generates a [Prepayment created](https://developers.pismo.io/events/docs/lending-prepayment-creation-1) event. **Note**: This endpoint requires an [account-specific access token](ref:get-an-account-specific-token-basic-authentication). - [Create repayment hierarchy](https://developers.pismo.io/pismo-docs/reference/createrepaymenthierarchyv2.md): Create a repayment hierarchy for a loan. The repayment hierarchy determines the order in which loan components are paid during repayment processing. - [Get repayment hierarchy](https://developers.pismo.io/pismo-docs/reference/getrepaymenthierarchyv2.md): Get a repayment hierarchy by its code, including the hierarchy order and current status. ## Changelog - [7 August 2026](https://developers.pismo.io/pismo-docs/changelog/7-august-2026.md) - [2 July 2026](https://developers.pismo.io/pismo-docs/changelog/2-july-2026.md) - [5 June 2026](https://developers.pismo.io/pismo-docs/changelog/5-june-2026.md) - [1 May 2026](https://developers.pismo.io/pismo-docs/changelog/1-may-2026.md) - [3 April 2026](https://developers.pismo.io/pismo-docs/changelog/3-april-2026.md) - [6 March 2026](https://developers.pismo.io/pismo-docs/changelog/6-march-2026.md) - [6 February 2026](https://developers.pismo.io/pismo-docs/changelog/6-february-2026.md) - [9 January 2026](https://developers.pismo.io/pismo-docs/changelog/9-january-2026.md) - [5 December 2025](https://developers.pismo.io/pismo-docs/changelog/5-december-2025.md) - [7 November 2025](https://developers.pismo.io/pismo-docs/changelog/7-november-2025.md) # Pismo - Events Documentation > Reference for developers using streaming data events on the Pismo platform. ## Guides - [Common event fields](https://developers.pismo.io/events/docs/event-base-main-event.md) - [Account cancelled](https://developers.pismo.io/events/docs/audit-account-cancellation-1.md) - [Account entity updated](https://developers.pismo.io/events/docs/audit-entity-change-1.md) - [Account parameter updated](https://developers.pismo.io/events/docs/audit-account-parameter-change-1.md) - [Account status updated](https://developers.pismo.io/events/docs/audit-account-status-change-2.md) - [Address created](https://developers.pismo.io/events/docs/audit-address-creation-1.md) - [Address updated](https://developers.pismo.io/events/docs/audit-address-change-1.md) - [Phone created](https://developers.pismo.io/events/docs/audit-phone-creation-1.md) - [Phone updated](https://developers.pismo.io/events/docs/audit-phone-change-1.md) - [Account flex control created](https://developers.pismo.io/events/docs/audit-account-spending-limit-created-1.md) - [Account flex control updated](https://developers.pismo.io/events/docs/audit-account-spending-limit-updated-1.md) - [Customer spending limit created](https://developers.pismo.io/events/docs/audit-customer-spending-limit-created-1.md) - [Customer spending limit updated](https://developers.pismo.io/events/docs/audit-customer-spending-limit-updated-1.md) - [Evaluation requested](https://developers.pismo.io/events/docs/audit-evaluation-requested-1.md) - [Evaluation rollback request created](https://developers.pismo.io/events/docs/audit-evaluation-rollback-requested-1.md) - [Flex control template created](https://developers.pismo.io/events/docs/audit-template-created-1.md) - [Flex control template updated](https://developers.pismo.io/events/docs/audit-template-updated-1.md) - [Authorization user updated](https://developers.pismo.io/events/docs/audit-auth-update-user-1.md) - [Card created](https://developers.pismo.io/events/docs/audit-card-creation-1.md) - [Card updated](https://developers.pismo.io/events/docs/audit-card-change-1.md) - [Card on file exclusion created](https://developers.pismo.io/events/docs/audit-cardsonfile-exclusion-1.md) - [Cashout transfer completed](https://developers.pismo.io/events/docs/audit-transfer-cash-out-1.md) - [Dispute created](https://developers.pismo.io/events/docs/audit-dispute-creation-2.md) - [Dispute created](https://developers.pismo.io/events/docs/audit-dispute-creation-1.md) - [Dispute file uploaded](https://developers.pismo.io/events/docs/audit-dispute-upload-file-1.md) - [Dispute status updated](https://developers.pismo.io/events/docs/audit-dispute-status-change-2.md) - [Dispute status updated](https://developers.pismo.io/events/docs/audit-dispute-status-change-1.md) - [p2m contract data updated](https://developers.pismo.io/events/docs/audit-contract-data-change-1.md) - [p2m register data updated](https://developers.pismo.io/events/docs/audit-register-data-change-1.md) - [p2m store data updated](https://developers.pismo.io/events/docs/audit-store-data-change-1.md) - [User setup created](https://developers.pismo.io/events/docs/audit-user-setup-create-1.md) - [User deactivated](https://developers.pismo.io/events/docs/audit-inactive-user-1.md) - [External accounting entry created](https://developers.pismo.io/events/docs/audit-external-entry-1.md) - [Evaluation updated](https://developers.pismo.io/events/docs/audit-evaluation-updated-1.md) - [New file available in bucket](https://developers.pismo.io/events/docs/dataplatform-new-bucket-object-1.md) - [JSON schema change](https://developers.pismo.io/events/docs/dataplatform-json-schema-change-1.md) - [Sign of health status](https://developers.pismo.io/events/docs/dataplatform-health-check-1.md) - [Cancellation timeline event from base II processing added](https://developers.pismo.io/events/docs/timeline-confirmation-cancellation-1.md) - [Incremental authorization timeline event added](https://developers.pismo.io/events/docs/timeline-authorization-incremental-1.md) - [Authorization refused (denied) timeline event added](https://developers.pismo.io/events/docs/timeline-authorization-refusal-1.md) - [Confirmation timeline event for authorization replacement added](https://developers.pismo.io/events/docs/timeline-confirmation-replacement-1.md) - [Authorization partial cancellation timeline event added](https://developers.pismo.io/events/docs/timeline-authorization-partial-cancellation-1.md) - [Authorization replacement timeline event added](https://developers.pismo.io/events/docs/timeline-authorization-replacement-1.md) - [Card tokenization timeline event added](https://developers.pismo.io/events/docs/timeline-card-tokenization-1.md) - [Dispute status change timeline event added](https://developers.pismo.io/events/docs/timeline-dispute-status-1.md) - [Authorization cancellation refusal (denied) timeline event added](https://developers.pismo.io/events/docs/timeline-authorization-cancellation-refusal-1.md) - [Authorization confirmation timeline event added](https://developers.pismo.io/events/docs/timeline-confirmation-authorize-1.md) - [Authorization cancellation timeline event added](https://developers.pismo.io/events/docs/timeline-authorization-cancellation-1.md) - [Authorization timeline event added](https://developers.pismo.io/events/docs/timeline-authorization-authorize-1.md) - [Authorization cancellation reversal timeline event added](https://developers.pismo.io/events/docs/timeline-authorization-cancellation-reversal-1.md) - [Authorization referral timeline event added](https://developers.pismo.io/events/docs/timeline-authorization-referral-1.md) - [Account due date changed](https://developers.pismo.io/events/docs/account-due-date-update-1.md) - [Account owner changed](https://developers.pismo.io/events/docs/account-account-owner-change-1.md) - [Account status created](https://developers.pismo.io/events/docs/account-status-creation-1.md) - [Account status changed](https://developers.pismo.io/events/docs/account-status-change-2.md) - [Account migrated to different program](https://developers.pismo.io/events/docs/account-program-migration-1.md) - [Customer created](https://developers.pismo.io/events/docs/account-customer-creation-1.md) - [Customer changed](https://developers.pismo.io/events/docs/account-customer-change-2.md) - [Reason created](https://developers.pismo.io/events/docs/account-reason-creation-1.md) - [Corporate account created](https://developers.pismo.io/events/docs/account-corporate-creation-1.md) - [Account information changed](https://developers.pismo.io/events/docs/account-account-change-2.md) - [Account status change failure](https://developers.pismo.io/events/docs/account-status-change-failure-1.md) - [Account parameter changed](https://developers.pismo.io/events/docs/account-account-parameter-change-1.md) - [Program created](https://developers.pismo.io/events/docs/programs-creation-1.md) - [Program updated](https://developers.pismo.io/events/docs/programs-update-1.md) - [Accounting entry created](https://developers.pismo.io/events/docs/accounting-entry-creation-1.md) - [Authorization created](https://developers.pismo.io/events/docs/authorization-authorization-event-1.md) - [Authorization cancelled](https://developers.pismo.io/events/docs/authorization-authorization-cancellation-event-1.md) - [Mastercard raw credit authorization received](https://developers.pismo.io/events/docs/authorization-raw-credit-mastercard-1.md) - [Masterard raw debit authorization received](https://developers.pismo.io/events/docs/authorization-raw-debit-mastercard-1.md) - [Visa raw credit authorization received](https://developers.pismo.io/events/docs/authorization-raw-credit-visa-1.md) - [Visa raw debit authorization received](https://developers.pismo.io/events/docs/authorization-raw-debit-visa-1.md) - [Over-limit created](https://developers.pismo.io/events/docs/authorization-overlimit-creation-1.md) - [Over-limit control (internal)](https://developers.pismo.io/events/docs/authorization-overlimit-control-1.md) - [Available ledger balance changed](https://developers.pismo.io/events/docs/availables-change-available-1.md) - [Balance configuration created](https://developers.pismo.io/events/docs/balances-config-created-1.md) - [Balance configuration updated](https://developers.pismo.io/events/docs/balances-config-updated-1.md) - [Account limit changed](https://developers.pismo.io/events/docs/ledger-limit-changed-1.md) - [Account balance statement update completed](https://developers.pismo.io/events/docs/migration-account-balance-statement-update-outgoing-1.md) - [Account go-live completed](https://developers.pismo.io/events/docs/migration-account-go-live-outgoing-1.md) - [Account migration started (v1)](https://developers.pismo.io/events/docs/migration-account-incoming-1.md) - [Account migration started (v2)](https://developers.pismo.io/events/docs/migration-account-incoming-2.md) - [Account migration completed (v1)](https://developers.pismo.io/events/docs/migration-account-outgoing-1.md) - [Account migration completed (v2)](https://developers.pismo.io/events/docs/migration-account-outgoing-2.md) - [Account overlimit migration completed](https://developers.pismo.io/events/docs/migration-account-overlimit-outgoing-1.md) - [Accrual migration started](https://developers.pismo.io/events/docs/migration-accrual-incoming-1.md) - [Accrual migration completed](https://developers.pismo.io/events/docs/migration-accrual-outgoing-1.md) - [Authorization migration started](https://developers.pismo.io/events/docs/migration-authorization-incoming-1.md) - [Authorization migration completed](https://developers.pismo.io/events/docs/migration-authorization-outgoing-1.md) - [Balance control migration started](https://developers.pismo.io/events/docs/migration-balance-control-incoming-1.md) - [Balance control migration completed](https://developers.pismo.io/events/docs/migration-balance-control-outgoing-1.md) - [Card migration started](https://developers.pismo.io/events/docs/migration-card-incoming-1.md) - [Card migration completed events](https://developers.pismo.io/events/docs/migration-card-outgoing-1.md) - [Combo card mode migration completed](https://developers.pismo.io/events/docs/migration-card-mode-outgoing-1.md) - [Customer migration started](https://developers.pismo.io/events/docs/migration-customer-incoming-1.md) - [Customer migration completed](https://developers.pismo.io/events/docs/migration-customer-outgoing-1.md) - [Delinquency bucket migration started](https://developers.pismo.io/events/docs/migration-delinquency-bucket-incoming-1.md) - [Delinquency bucket migration completed](https://developers.pismo.io/events/docs/migration-delinquency-bucket-outgoing-1.md) - [Dispute migration completed](https://developers.pismo.io/events/docs/migration-dispute-outgoing-1.md) - [Dispute migration started](https://developers.pismo.io/events/docs/migration-dispute-incoming-1.md) - [Fee Model account migration completed](https://developers.pismo.io/events/docs/migration-fee-model-account-outgoing-1.md) - [Fee model account migration started](https://developers.pismo.io/events/docs/migration-fee-model-account-incoming-1.md) - [File summary migration status reported](https://developers.pismo.io/events/docs/migration-file-summary-1.md) - [File unparsable line reported](https://developers.pismo.io/events/docs/migration-file-unparsable-line-1.md) - [Instant payment transaction migration completed](https://developers.pismo.io/events/docs/migration-instant-payment-outgoing-1.md) - [Merchant migration started](https://developers.pismo.io/events/docs/migration-merchant-incoming-1.md) - [Merchant migration completed](https://developers.pismo.io/events/docs/migration-merchant-outgoing-1.md) - [Merchant Transaction migration started](https://developers.pismo.io/events/docs/migration-merchant-transaction-incoming-1.md) - [Merchant transactions migration completed](https://developers.pismo.io/events/docs/migration-merchant-transaction-outgoing-1.md) - [Migration pre-go-live error](https://developers.pismo.io/events/docs/migration-pre-go-live-outgoing-1.md) - [Migration go-live error](https://developers.pismo.io/events/docs/migration-go-live-outgoing-1.md) - [On-us authorization migration started](https://developers.pismo.io/events/docs/migration-on-us-authorization-incoming-1.md) - [On-us authorization migration completed](https://developers.pismo.io/events/docs/migration-on-us-authorization-outgoing-1.md) - [Payment agreement migration started](https://developers.pismo.io/events/docs/migration-payment-agreement-incoming-1.md) - [Payment agreement migration completed](https://developers.pismo.io/events/docs/migration-payment-agreement-outgoing-1.md) - [PCI card migration completed](https://developers.pismo.io/events/docs/migration-pci-card-outgoing-1.md) - [Pre go-live migration completed](https://developers.pismo.io/events/docs/migration-account-pre-go-live-outgoing-1.md) - [Pre scheduled transaction migration started](https://developers.pismo.io/events/docs/migration-pre-scheduled-transaction-incoming-1.md) - [Pre scheduled transaction migration completed](https://developers.pismo.io/events/docs/migration-pre-scheduled-transaction-outgoing-1.md) - [Recurring Charge link migration started](https://developers.pismo.io/events/docs/migration-recurring-charge-link-incoming-1.md) - [Recurring charge link migration completed](https://developers.pismo.io/events/docs/migration-recurring-charge-link-outgoing-1.md) - [Recurring Charge plan migration started](https://developers.pismo.io/events/docs/migration-recurring-charge-plan-incoming-1.md) - [Recurring charge plan migration completed](https://developers.pismo.io/events/docs/migration-recurring-charge-plan-outgoing-1.md) - [Statement migration started](https://developers.pismo.io/events/docs/migration-statement-incoming-1.md) - [Statement migration completed](https://developers.pismo.io/events/docs/migration-statement-outgoing-1.md) - [Token migration started](https://developers.pismo.io/events/docs/migration-token-incoming-1.md) - [Token migration completed](https://developers.pismo.io/events/docs/migration-token-outgoing-1.md) - [Transaction migration started](https://developers.pismo.io/events/docs/migration-transaction-incoming-1.md) - [Transaction migration completed](https://developers.pismo.io/events/docs/migration-transaction-outgoing-1.md) - [File split outgoing migration status reported](https://developers.pismo.io/events/docs/migration-file-splitter-outgoing-1.md) - [Statement organized migration completed](https://developers.pismo.io/events/docs/migration-organize-statement-outgoing-1.md) - [Phase parameters migration started](https://developers.pismo.io/events/docs/migration-phase-parameters-incoming-1.md) - [Phase parameters migration completed](https://developers.pismo.io/events/docs/migration-phase-parameters-outgoing-1.md) - [Statement organized migration completed](https://developers.pismo.io/events/docs/migration-statement-organized-outgoing-1.md) - [Orgs operation created](https://developers.pismo.io/events/docs/orgs-operation-create-1.md) - [Orgs operation updated](https://developers.pismo.io/events/docs/orgs-operation-update-1.md) - [Account application prospect created](https://developers.pismo.io/events/docs/onboarding-prospect-1.md) - [Account application created](https://developers.pismo.io/events/docs/onboarding-succeeded-1.md) - [Customer application created](https://developers.pismo.io/events/docs/onboarding-customer-succeeded-1.md) - [Payment methods authorization created](https://developers.pismo.io/events/docs/payment-methods-authorization-1.md) - [Payment methods multiple transfers completed](https://developers.pismo.io/events/docs/payment-methods-multiple-transfers-1.md) - [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1.md) - [Scheduled payment created or modified](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-1.md) - [Scheduled payment executed](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-execution-1.md) - [Bulk pre-schedules created](https://developers.pismo.io/events/docs/scheduler-payments-bulk-pre-scheduled-payments-1.md) - [Scheduled payment table record (internal)](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-table-1.md) - [Scheduled payment execution table record (internal)](https://developers.pismo.io/events/docs/scheduler-payments-scheduled-payments-execution-table-1.md) - [Bulk single schedules created](https://developers.pismo.io/events/docs/scheduler-payments-bulk-single-scheduled-payments-1.md) - [Bulk transfer schedules created](https://developers.pismo.io/events/docs/scheduler-payments-bulk-transfer-scheduled-payments-1.md) - [Transaction created](https://developers.pismo.io/events/docs/transaction-creation-1.md) - [Transaction updated](https://developers.pismo.io/events/docs/transaction-update-1.md) - [First page created](https://developers.pismo.io/events/docs/transaction-cache-1.md) - [Transaction type created](https://developers.pismo.io/events/docs/transaction-types-creation-1.md) - [3DS pre-authentication received](https://developers.pismo.io/events/docs/anti-fraud-pre-authentication-1.md) - [3DS authentication result received](https://developers.pismo.io/events/docs/anti-fraud-authentication-result-1.md) - [Calendar updated](https://developers.pismo.io/events/docs/balance-calendar-updated-1.md) - [Balance account changed](https://developers.pismo.io/events/docs/balance-balance-account-change-1.md) - [Program due date created](https://developers.pismo.io/events/docs/balance-program-due-date-created-1.md) - [Installment payment processed](https://developers.pismo.io/events/docs/balance-installment-payment-processed-1.md) - [Transactions shifted](https://developers.pismo.io/events/docs/balance-shift-transactions-1.md) - [Installment advanced](https://developers.pismo.io/events/docs/balance-installment-advancement-1.md) - [Accrual created](https://developers.pismo.io/events/docs/balance-accrual-data-1.md) - [Credit transaction used for discharge](https://developers.pismo.io/events/docs/balance-discharge-1.md) - [Program due date changed](https://developers.pismo.io/events/docs/balance-program-due-date-changed-1.md) - [Delinquency bucket updated](https://developers.pismo.io/events/docs/balance-statements-delinquency-bucket-updated-1.md) - [Accrual status changed](https://developers.pismo.io/events/docs/balance-accrual-status-1.md) - [Delinquency bucket created](https://developers.pismo.io/events/docs/balance-statements-delinquency-bucket-created-1.md) - [Reversal accrual created](https://developers.pismo.io/events/docs/balance-reversal-accrual-data-1.md) - [Calendar created](https://developers.pismo.io/events/docs/balance-calendar-created-1.md) - [Statement Rollback](https://developers.pismo.io/events/docs/balance-statement-rollback-1.md) - [Payment Agreement Rollback](https://developers.pismo.io/events/docs/balance-payment-agreement-rollback-1.md) - [Recurring charge plan link terminated](https://developers.pismo.io/events/docs/balance-recurring-charge-plan-linked-to-account-terminated-1.md) - [Recurring scheduled charge updated](https://developers.pismo.io/events/docs/balance-recurring-scheduled-charge-updated-1.md) - [Recurring charge plan unlinked from account](https://developers.pismo.io/events/docs/balance-recurring-charge-plan-unlinked-from-account-1.md) - [Recurring scheduled charge canceled](https://developers.pismo.io/events/docs/balance-recurring-scheduled-charge-cancelled-1.md) - [Recurring scheduled charge created](https://developers.pismo.io/events/docs/balance-recurring-scheduled-charge-created-1.md) - [Recurring scheduled charge settled](https://developers.pismo.io/events/docs/balance-recurring-scheduled-charge-settled-1.md) - [Recurring charge plan created](https://developers.pismo.io/events/docs/balance-recurring-charge-plan-created-1.md) - [Recurring scheduled charge processed](https://developers.pismo.io/events/docs/balance-recurring-scheduled-charge-processed-1.md) - [Recurring charge plan linked to account](https://developers.pismo.io/events/docs/balance-recurring-charge-plan-linked-to-account-1.md) - [Recurring charge plan disabled](https://developers.pismo.io/events/docs/balance-recurring-charge-plan-disabled-1.md) - [Interest Accrual Rollback](https://developers.pismo.io/events/docs/balance-interest-accrual-rollback-1.md) - [Installment advancementcanceled](https://developers.pismo.io/events/docs/balance-installment-advancement-cancelled-1.md) - [Accrual data changed](https://developers.pismo.io/events/docs/balance-accrual-data-change-1.md) - [Debit transaction used for recharge](https://developers.pismo.io/events/docs/balance-recharge-1.md) - [Program calendar strategy created](https://developers.pismo.io/events/docs/balance-program-calendar-strategy-created-1.md) - [Program calendar strategy updated](https://developers.pismo.io/events/docs/balance-program-calendar-strategy-updated-1.md) - [Revolving statement summary](https://developers.pismo.io/events/docs/balance-revolving-statement-summary-1.md) - [Installment advancement not processed](https://developers.pismo.io/events/docs/balance-installment-advancement-not-processed-1.md) - [Installment advanced not canceled](https://developers.pismo.io/events/docs/balance-installment-advancement-not-cancelled-1.md) - [Statement amortization discharge](https://developers.pismo.io/events/docs/balance-statement-amortization-1.md) - [Cycle closing request error](https://developers.pismo.io/events/docs/balance-cycle-closing-request-error-1.md) - [Cycle closing requested](https://developers.pismo.io/events/docs/balance-cycle-closing-requested-1.md) - [Installment payment not processed](https://developers.pismo.io/events/docs/balance-installment-payment-not-processed-1.md) - [Account calendar strategy changed](https://developers.pismo.io/events/docs/balance-account-calendar-strategy-changed-1.md) - [Account due date changed](https://developers.pismo.io/events/docs/balance-account-due-date-changed-1.md) - [Statement Update](https://developers.pismo.io/events/docs/balance-statement-update-1.md) - [Bulletin rule created or retrieved](https://developers.pismo.io/events/docs/bulletin-bulletin-rule-1.md) - [Protection Bulletin card updated](https://developers.pismo.io/events/docs/bulletin-bulletin-cards-change-1.md) - [Protection Bulletin card deleted](https://developers.pismo.io/events/docs/bulletin-bulletin-cards-delete-1.md) - [Protection Bulletin card created](https://developers.pismo.io/events/docs/bulletin-bulletin-cards-creation-1.md) - [Embossing rejection file processed](https://developers.pismo.io/events/docs/cards-card-rejection-1.md) - [Customer bound to noname card](https://developers.pismo.io/events/docs/cards-bind-card-1.md) - [Card created](https://developers.pismo.io/events/docs/cards-create-1.md) - [Card migrated](https://developers.pismo.io/events/docs/cards-migration-1.md) - [Card type updated](https://developers.pismo.io/events/docs/cards-update-type-1.md) - [Card embossing notification received](https://developers.pismo.io/events/docs/cards-embossing-1.md) - [Card updated](https://developers.pismo.io/events/docs/cards-update-1.md) - [Card password changed](https://developers.pismo.io/events/docs/cards-update-password-1.md) - [Card postage processed](https://developers.pismo.io/events/docs/cards-control-post-ingress-1.md) - [Card issuer script notification received](https://developers.pismo.io/events/docs/cards-issuer-script-1.md) - [Card can be added to next scheduled embossing](https://developers.pismo.io/events/docs/cards-embossing-card-ingress-1.md) - [Embossing summary received](https://developers.pismo.io/events/docs/cards-embossing-summary-1.md) - [Automatic Updater notification file sent](https://developers.pismo.io/events/docs/cards-automatic-updater-1.md) - [Card CVV changed](https://developers.pismo.io/events/docs/cards-rotate-cvv-1.md) - [Abu return file summary](https://developers.pismo.io/events/docs/cards-abu-return-file-summary-1.md) - [ABU return file error by card](https://developers.pismo.io/events/docs/cards-abu-return-file-card-error-1.md) - [Card embossing ondemand received](https://developers.pismo.io/events/docs/cards-embossing-ondemand-1.md) - [Noname cancellation](https://developers.pismo.io/events/docs/cards-noname-cancellation-1.md) - [Card reembossing notification received](https://developers.pismo.io/events/docs/cards-reembossing-1.md) - [Card benefits notification allocation](https://developers.pismo.io/events/docs/cards-benefits-allocation-1.md) - [Card benefits allocation return file](https://developers.pismo.io/events/docs/cards-benefits-allocation-return-file-1.md) - [Card program updated](https://developers.pismo.io/events/docs/cards-card-program-migration-1.md) - [Token provisioning rejected](https://developers.pismo.io/events/docs/cards-tokenization-notification-refusal-1.md) - [Token provisioning request received](https://developers.pismo.io/events/docs/cards-tokenization-notification-1.md) - [PAN updated](https://developers.pismo.io/events/docs/cards-tokenization-pan-update-1.md) - [Token resync](https://developers.pismo.io/events/docs/cards-tokenization-token-resync-1.md) - [Click to Pay event generated](https://developers.pismo.io/events/docs/cards-tokenization-click-to-pay-1.md) - [Token Requestor DB stream event](https://developers.pismo.io/events/docs/token-requestor-token-requestor-stream-1.md) - [Card metadata deleted](https://developers.pismo.io/events/docs/cardsonfile-delete-metadata-1.md) - [Card on file validation result received](https://developers.pismo.io/events/docs/cardsonfile-verification-1.md) - [Card excluded](https://developers.pismo.io/events/docs/cardsonfile-exclusion-1.md) - [Card on file updated](https://developers.pismo.io/events/docs/cardsonfile-patch-cards-1.md) - [Card on file created](https://developers.pismo.io/events/docs/cardsonfile-provision-1.md) - [Clearing processing non-financial message received](https://developers.pismo.io/events/docs/clearing-non-financial-1.md) - [Clearing processing summary received](https://developers.pismo.io/events/docs/clearing-summary-1.md) - [Late transaction posted](https://developers.pismo.io/events/docs/delinquent-account-late-transaction-1.md) - [Delinquent account scheduled to be closed](https://developers.pismo.io/events/docs/delinquent-account-delinquent-account-warning-1.md) - [Delinquent account closed](https://developers.pismo.io/events/docs/delinquent-account-delinquent-account-1.md) - [Dispute status changed](https://developers.pismo.io/events/docs/disputes-dispute-installment-status-change-1.md) - [Dispute resolution reconcilied](https://developers.pismo.io/events/docs/disputes-dispute-resolution-reconciliation-events-1.md) - [Dispute fee status created](https://developers.pismo.io/events/docs/disputes-dispute-fee-events-1.md) - [Dispute installment created](https://developers.pismo.io/events/docs/disputes-dispute-installment-creation-1.md) - [Authorization fraud report status changed](https://developers.pismo.io/events/docs/disputes-authorization-fraud-report-status-change-1.md) - [Authorization fraud report created](https://developers.pismo.io/events/docs/disputes-authorization-fraud-report-creation-1.md) - [Elo inclusive transactions not processed](https://developers.pismo.io/events/docs/disputes-elo-inclusive-transactions-not-processed-1.md) - [Dispute status changed](https://developers.pismo.io/events/docs/disputes-dispute-status-changed-1.md) - [Dispute created](https://developers.pismo.io/events/docs/disputes-disputes-creation-1.md) - [Fraud report created](https://developers.pismo.io/events/docs/fraud-report-fraud-report-creation-1.md) - [Fraud report updated](https://developers.pismo.io/events/docs/fraud-report-fraud-report-change-1.md) - [Network authorization ISO8583 message received](https://developers.pismo.io/events/docs/networktransactions-iso8583-message-1.md) - [Network authorization received](https://developers.pismo.io/events/docs/networktransactions-network-authorization-1.md) - [Card network authorization return sent](https://developers.pismo.io/events/docs/networktransactions-network-message-1.md) - [Network authorization clearing message received](https://developers.pismo.io/events/docs/networktransactions-clearing-1.md) - [Network authorization clearing raw message received (DEPRECATED)](https://developers.pismo.io/events/docs/networktransactions-clearing-raw-1.md) - [Pending transactions sent](https://developers.pismo.io/events/docs/networktransactions-pending-transactions-2.md) - [Statement cycle closed](https://developers.pismo.io/events/docs/statements-cycle-closing-1.md) - [Statement cycle real due date reached](https://developers.pismo.io/events/docs/statements-cycle-due-date-1.md) - [Statement cycle opened](https://developers.pismo.io/events/docs/statements-cycle-opening-1.md) - [Statement cycle due date reached](https://developers.pismo.io/events/docs/statements-due-date-statement-cycle-1.md) - [Payment agreement simulation not processed](https://developers.pismo.io/events/docs/statement-refinancing-payment-agreement-simulation-not-processed-1.md) - [Payment agreement simulation processed](https://developers.pismo.io/events/docs/statement-refinancing-payment-agreement-simulation-processed-1.md) - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1.md) - [Account balance history generated](https://developers.pismo.io/events/docs/account-balances-balance-history-1.md) - [Account balance history configuration created](https://developers.pismo.io/events/docs/account-balances-balance-history-config-creation-1.md) - [Account balance history configuration changed](https://developers.pismo.io/events/docs/account-balances-balance-history-config-change-1.md) - [Cycle closing configuration created](https://developers.pismo.io/events/docs/account-balances-cycle-close-config-1.md) - [Asset updated](https://developers.pismo.io/events/docs/assets-asset-update-1.md) - [Asset registration succeeded](https://developers.pismo.io/events/docs/assets-asset-registration-success-1.md) - [Quota updated](https://developers.pismo.io/events/docs/assets-quota-update-1.md) - [Asset blocked](https://developers.pismo.io/events/docs/assets-asset-block-1.md) - [Asset accrued](https://developers.pismo.io/events/docs/assets-asset-accrual-2.md) - [Asset block failed](https://developers.pismo.io/events/docs/assets-asset-block-failure-1.md) - [Asset redeemed](https://developers.pismo.io/events/docs/assets-asset-redemption-1.md) - [Asset redemption failed](https://developers.pismo.io/events/docs/assets-asset-redemption-failure-1.md) - [Asset accrued](https://developers.pismo.io/events/docs/assets-asset-accrual-1.md) - [Asset status changed](https://developers.pismo.io/events/docs/assets-asset-status-change-1.md) - [Asset registration failed](https://developers.pismo.io/events/docs/assets-asset-registration-failure-1.md) - [Asset registration succeeded](https://developers.pismo.io/events/docs/assets-asset-registration-success-2.md) - [Unlink asset request event](https://developers.pismo.io/events/docs/assets-collateral-asset-unblock-1.md) - [Collateral contract registration request event](https://developers.pismo.io/events/docs/assets-collateral-contract-registration-1.md) - [Collateral default contract registration request event](https://developers.pismo.io/events/docs/assets-collateral-default-contract-registration-1.md) - [Link Asset Request event](https://developers.pismo.io/events/docs/assets-collateral-asset-block-1.md) - [Collateral default contract registration request was failed](https://developers.pismo.io/events/docs/assets-collateral-default-contract-registration-failure-1.md) - [Operation request succeed](https://developers.pismo.io/events/docs/assets-collateral-operation-success-1.md) - [Operation request failed](https://developers.pismo.io/events/docs/assets-collateral-operation-failure-1.md) - [Collateral default contract registration request was succeed](https://developers.pismo.io/events/docs/assets-collateral-default-contract-registration-success-1.md) - [Collateral contract registration request was failed](https://developers.pismo.io/events/docs/assets-collateral-contract-registration-failure-1.md) - [Collateral contract registration request was succeed](https://developers.pismo.io/events/docs/assets-collateral-contract-registration-success-1.md) - [Asset migrate failed](https://developers.pismo.io/events/docs/assets-asset-migrate-failure-1.md) - [Asset Migrated](https://developers.pismo.io/events/docs/assets-asset-migrate-1.md) - [Asset completed event success](https://developers.pismo.io/events/docs/assets-asset-completed-event-success-1.md) - [Asset Redemption Cancellation Failure](https://developers.pismo.io/events/docs/assets-asset-redemption-cancellation-failure-1.md) - [Asset Redemption Cancellation Success](https://developers.pismo.io/events/docs/assets-asset-redemption-cancellation-success-1.md) - [Asset Quota block failed](https://developers.pismo.io/events/docs/assets-asset-quota-block-failure-1.md) - [Asset Quota Blocked](https://developers.pismo.io/events/docs/assets-asset-quota-block-success-1.md) - [Average balance calculated](https://developers.pismo.io/events/docs/average-balance-calculated-average-balance-1.md) - [BCB SPB transfer processed](https://developers.pismo.io/events/docs/bacen-spb-str-1.md) - [BACS direct credit inbound return payment processed](https://developers.pismo.io/events/docs/bacs-direct-credit-in-return-status-change-1.md) - [BACS direct credit inbound payment processed](https://developers.pismo.io/events/docs/bacs-direct-credit-in-status-change-1.md) - [BACS direct credit outbound return payment processed](https://developers.pismo.io/events/docs/bacs-direct-credit-out-return-status-change-1.md) - [BACS direct credit outbound payment processed.](https://developers.pismo.io/events/docs/bacs-direct-credit-out-status-change-1.md) - [BACS direct credit reversal processed](https://developers.pismo.io/events/docs/bacs-direct-credit-reversal-status-change-1.md) - [BACS direct debit outbound payment processed.](https://developers.pismo.io/events/docs/bacs-direct-debit-out-status-change-1.md) - [BACS direct debit return processed.](https://developers.pismo.io/events/docs/bacs-direct-debit-return-status-change-1.md) - [BACS mandate admission status change.](https://developers.pismo.io/events/docs/bacs-mandate-admission-status-change-1.md) - [BACS mandate status change.](https://developers.pismo.io/events/docs/bacs-mandate-status-change-1.md) - [BACS paper mandate status change.](https://developers.pismo.io/events/docs/bacs-paper-mandate-status-change-1.md) - [Document copies submitted](https://developers.pismo.io/events/docs/banking-prospect-documents-copy-1.md) - [Provider notification generated](https://developers.pismo.io/events/docs/banking-prospect-provider-notification-1.md) - [Bank slip registered](https://developers.pismo.io/events/docs/bank-slip-registered-bank-slip-1.md) - [Bank statement cycle closing completed](https://developers.pismo.io/events/docs/bank-statements-cycle-closing-1.md) - [Cash-in processing failed](https://developers.pismo.io/events/docs/banking-webhooks-cashin-failure-1.md) - [eBill notification generated](https://developers.pismo.io/events/docs/banking-webhooks-ebill-notification-1.md) - [Check posting status changed](https://developers.pismo.io/events/docs/cash-management-check-status-change-1.md) - [Check settlement status changed](https://developers.pismo.io/events/docs/cash-management-check-settlement-status-change-1.md) - [Channel created, updated, or deleted](https://developers.pismo.io/events/docs/cash-management-channel-1.md) - [Multi-leg payment lifecycle status changed](https://developers.pismo.io/events/docs/corporate-multi-leg-status-change-1.md) - [Multi-leg payment lifecycle created](https://developers.pismo.io/events/docs/corporate-multi-leg-creation-1.md) - [Dormancy configuration updated](https://developers.pismo.io/events/docs/corporate-dormancy-config-change-1.md) - [Corporate account updated](https://developers.pismo.io/events/docs/corporate-corporate-account-change-1.md) - [Corporate hierarchy created](https://developers.pismo.io/events/docs/corporate-hierarchy-creation-1.md) - [Corporate account created](https://developers.pismo.io/events/docs/corporate-corporate-account-creation-1.md) - [Corporate division created (deprecated)](https://developers.pismo.io/events/docs/corporate-division-creation-1.md) - [Current scheduled payment status displayed](https://developers.pismo.io/events/docs/corporate-schedule-payment-1.md) - [Earmark created, updated, or canceled](https://developers.pismo.io/events/docs/corporate-earmark-1.md) - [Corporate division updated (deprecated)](https://developers.pismo.io/events/docs/corporate-division-change-1.md) - [Dormancy configuration created](https://developers.pismo.io/events/docs/corporate-dormancy-config-creation-1.md) - [Float payment lifecycle status changed](https://developers.pismo.io/events/docs/corporate-float-payment-status-change-1.md) - [Bulk payment processing status changed](https://developers.pismo.io/events/docs/corporate-bulk-status-changed-1.md) - [Corporate division updated v2](https://developers.pismo.io/events/docs/corporate-division-change-2.md) - [Corporate division created](https://developers.pismo.io/events/docs/corporate-division-creation-2.md) - [Future dated payment lifecycle event](https://developers.pismo.io/events/docs/corporate-future-dated-payment-1.md) - [Bulk settlement processing status changed](https://developers.pismo.io/events/docs/corporate-bulk-settlement-1.md) - [Division cycle closing completed](https://developers.pismo.io/events/docs/corporate-division-cycle-closing-1.md) - [Earmark internal operation execution tracking](https://developers.pismo.io/events/docs/corporate-earmark-internal-operation-status-1.md) - [Operations Blocks created, updated, or canceled](https://developers.pismo.io/events/docs/corporate-operation-block-1.md) - [Restricted Funds created or released](https://developers.pismo.io/events/docs/corporate-restricted-funds-1.md) - [Multi-leg payment lifecycle status changed](https://developers.pismo.io/events/docs/corporate-multi-leg-status-change-2.md) - [Multi-leg payment lifecycle created](https://developers.pismo.io/events/docs/corporate-multi-leg-creation-2.md) - [Corporate Account Rollback Completed](https://developers.pismo.io/events/docs/corporate-corporate-account-rollback-completed-1.md) - [Force account closure succeeded](https://developers.pismo.io/events/docs/corporate-force-account-closure-1.md) - [Account inactive_since status updated](https://developers.pismo.io/events/docs/corporate-inactive-since-updated-1.md) - [Transaction banking account migration go live requested](https://developers.pismo.io/events/docs/corporate-transaction-banking-account-migration-go-live-requested-1.md) - [Transaction banking account migration output](https://developers.pismo.io/events/docs/corporate-transaction-banking-account-migration-output-1.md) - [Contract digital receivable supplement created](https://developers.pismo.io/events/docs/credit-rights-contract-digital-receivable-supplement-create-success-1.md) - [Digital receivable create succeeded](https://developers.pismo.io/events/docs/credit-rights-digital-receivable-create-success-1.md) - [Digital receivable create failed](https://developers.pismo.io/events/docs/credit-rights-digital-receivable-create-failure-1.md) - [Contract create success](https://developers.pismo.io/events/docs/credit-rights-contract-create-success-1.md) - [Contract create failure](https://developers.pismo.io/events/docs/credit-rights-contract-create-failure-1.md) - [Digital receivable unit contract create success](https://developers.pismo.io/events/docs/credit-rights-contract-digital-receivable-unit-create-success-1.md) - [Digital receivable unit contract creation failed](https://developers.pismo.io/events/docs/credit-rights-contract-digital-receivable-unit-create-failure-1.md) - [Digital receivable contract apply failure](https://developers.pismo.io/events/docs/credit-rights-digital-receivable-contract-apply-failure-1.md) - [Digital receivable contract apply success](https://developers.pismo.io/events/docs/credit-rights-digital-receivable-contract-apply-success-1.md) - [Contract summary event](https://developers.pismo.io/events/docs/credit-rights-contract-summary-1.md) - [Contract update including Digital Receivable failed.](https://developers.pismo.io/events/docs/credit-rights-digital-receivable-update-contract-failure-1.md) - [Contract update including Digital Receivable Unit failed.](https://developers.pismo.io/events/docs/credit-rights-contract-update-digital-receivable-unit-create-failure-1.md) - [Contract update including Digital Receivable Supplement processed successfully.](https://developers.pismo.io/events/docs/credit-rights-contract-update-digital-receivable-supplement-create-success-1.md) - [Contract update including Digital Receivable Supplement failed.](https://developers.pismo.io/events/docs/credit-rights-contract-update-digital-receivable-supplement-create-failure-1.md) - [Contract update including Digital Receivable Unit processed successfully.](https://developers.pismo.io/events/docs/credit-rights-contract-update-digital-receivable-unit-create-success-1.md) - [Contract update including Digital Receivable processed successfully.](https://developers.pismo.io/events/docs/credit-rights-digital-receivable-update-contract-success-1.md) - [Contract create failure](https://developers.pismo.io/events/docs/credit-rights-contract-update-failure-1.md) - [Contract create success](https://developers.pismo.io/events/docs/credit-rights-contract-update-success-1.md) - [Contract update failure](https://developers.pismo.io/events/docs/credit-rights-contract-processed-failure-1.md) - [Contract Processed Success](https://developers.pismo.io/events/docs/credit-rights-contract-processed-success-1.md) - [Contract digital receivable supplement created](https://developers.pismo.io/events/docs/credit-rights-contract-digital-receivable-supplement-processed-failure-1.md) - [Digital receivable unit contract creation failed](https://developers.pismo.io/events/docs/credit-rights-contract-digital-receivable-unit-processed-failure-1.md) - [Contract digital receivable supplement created](https://developers.pismo.io/events/docs/credit-rights-contract-digital-receivable-supplement-processed-success-1.md) - [Digital receivable create failed](https://developers.pismo.io/events/docs/credit-rights-digital-receivable-processed-failure-1.md) - [Digital receivable unit contract create success](https://developers.pismo.io/events/docs/credit-rights-contract-digital-receivable-unit-processed-success-1.md) - [Digital Receivable Event](https://developers.pismo.io/events/docs/credit-rights-digital-receivable-processed-success-1.md) - [Negotiable instrument act create failure](https://developers.pismo.io/events/docs/credit-rights-negotiable-instrument-act-processed-failure-1.md) - [Negotiable instrument act create success](https://developers.pismo.io/events/docs/credit-rights-negotiable-instrument-act-processed-success-1.md) - [Digital Receivable Processed Success (v2)](https://developers.pismo.io/events/docs/credit-rights-digital-receivable-processed-success-2.md) - [Validate invoice request failed](https://developers.pismo.io/events/docs/depositary-invoice-validation-request-failure-1.md) - [Credit rights receivable registration succeeded](https://developers.pismo.io/events/docs/depositary-credit-rights-registration-success-1.md) - [Unicity credit rights receivable validation failed](https://developers.pismo.io/events/docs/depositary-credit-rights-unicity-validation-failure-1.md) - [Unicity credit rights receivable validation succeeded](https://developers.pismo.io/events/docs/depositary-credit-rights-unicity-validation-success-1.md) - [Credit rights receivable registration failure](https://developers.pismo.io/events/docs/depositary-credit-rights-registration-failure-1.md) - [Invoice validation failed](https://developers.pismo.io/events/docs/depositary-invoice-validation-failure-1.md) - [Credit rights receivable status change failed](https://developers.pismo.io/events/docs/depositary-credit-rights-status-change-failure-1.md) - [Unit receivable n](https://developers.pismo.io/events/docs/depositary-unit-receivable-1.md) - [Credit rights receivable status change succeeded](https://developers.pismo.io/events/docs/depositary-credit-rights-status-change-success-1.md) - [Invoice validation succeeded](https://developers.pismo.io/events/docs/depositary-invoice-validation-success-1.md) - [Operations and status sent to EC](https://developers.pismo.io/events/docs/depositary-commercial-establishment-1.md) - [Credit rights receivable change failed](https://developers.pismo.io/events/docs/depositary-credit-rights-change-failure-1.md) - [Credit rights receivable change succeeded](https://developers.pismo.io/events/docs/depositary-credit-rights-change-success-1.md) - [Validate invoice request succeeded](https://developers.pismo.io/events/docs/depositary-invoice-validation-request-success-1.md) - [Event that represents a successful invoice monitoring request](https://developers.pismo.io/events/docs/depositary-invoice-monitoring-1.md) - [EC operation failed](https://developers.pismo.io/events/docs/depositary-commercial-establishment-failure-1.md) - [Unit receivable failed](https://developers.pismo.io/events/docs/depositary-unit-receivable-failure-1.md) - [Contract applied](https://developers.pismo.io/events/docs/depositary-contract-1.md) - [Contract Not Applied](https://developers.pismo.io/events/docs/depositary-contract-failure-1.md) - [Credit rights receivable registration succeeded](https://developers.pismo.io/events/docs/depositary-credit-rights-registration-success-2.md) - [Credit rights receivable registration failure](https://developers.pismo.io/events/docs/depositary-credit-rights-registration-failure-2.md) - [Credit rights receivable change succeeded](https://developers.pismo.io/events/docs/depositary-credit-rights-change-success-2.md) - [Credit rights receivable change failed](https://developers.pismo.io/events/docs/depositary-credit-rights-change-failure-2.md) - [Unit receivable confirm pre contracted operation failed](https://developers.pismo.io/events/docs/depositary-pre-contracted-cancellation-confirm-failed-1.md) - [Unit receivable confirm pre contracted operation succeeded](https://developers.pismo.io/events/docs/depositary-pre-contracted-cancellation-confirm-success-1.md) - [FPS inbound payment reversal processed](https://developers.pismo.io/events/docs/fps-fps-in-reversal-status-change-1.md) - [FPS out payment transaction event generated](https://developers.pismo.io/events/docs/fps-fps-out-status-change-1.md) - [FPS inbound payment processed](https://developers.pismo.io/events/docs/fps-fps-in-status-change-1.md) - [FPS inbound payment return processed](https://developers.pismo.io/events/docs/fps-fps-in-return-status-change-1.md) - [FPS outbound payment return processed](https://developers.pismo.io/events/docs/fps-fps-out-return-status-change-1.md) - [CoP name verification result received](https://developers.pismo.io/events/docs/fps-cop-name-verification-admissions-1.md) - [CoP name verification requested](https://developers.pismo.io/events/docs/fps-cop-name-verification-submissions-1.md) - [Instant pay scheduler status changed](https://developers.pismo.io/events/docs/instantpay-scheduler-scheduler-status-change-1.md) - [Instant pay execution status changed](https://developers.pismo.io/events/docs/instantpay-scheduler-execution-status-change-1.md) - [Payment order failed](https://developers.pismo.io/events/docs/instantpay-pullpayments-pix-recurrence-payment-order-failure-1.md) - [Pix recurrence payment order status changed](https://developers.pismo.io/events/docs/instantpay-pullpayments-pix-recurrence-payment-order-status-change-1.md) - [Pix recurrence status changed](https://developers.pismo.io/events/docs/instantpay-pullpayments-pix-recurrence-status-change-1.md) - [Pix recurrence authorization status changed](https://developers.pismo.io/events/docs/instantpay-pullpayments-pix-recurrence-authorization-status-change-1.md) - [Recurrence creation failed](https://developers.pismo.io/events/docs/instantpay-pullpayments-pix-automatic-recurrence-failure-1.md) - [Bank slip issuance canceled](https://developers.pismo.io/events/docs/integrated-payments-bankslip-issue-cancel-1.md) - [Bank slip issuance registered](https://developers.pismo.io/events/docs/integrated-payments-bankslip-issue-register-1.md) - [Bank slip issuance status changed](https://developers.pismo.io/events/docs/integrated-payments-bankslip-issue-status-change-1.md) - [Financial bank slip status changed](https://developers.pismo.io/events/docs/integrated-payments-bankslip-status-change-1.md) - [Financial transaction status updated.](https://developers.pismo.io/events/docs/integrated-payments-transaction-status-change-1.md) - [Financial transaction occurred](https://developers.pismo.io/events/docs/integrated-payments-transaction-ocurred-1.md) - [Integrated payments financial reconciliation](https://developers.pismo.io/events/docs/integrated-payments-financial-reconciliation-1.md) - [Transfer-in created](https://developers.pismo.io/events/docs/integrated-payments-transfer-in-created-1.md) - [Transfer-out created](https://developers.pismo.io/events/docs/integrated-payments-transfer-out-created-1.md) - [eBill registration status updated](https://developers.pismo.io/events/docs/integrated-payments-ebill-status-change-1.md) - [Deposit product created](https://developers.pismo.io/events/docs/deposit-product-creation-1.md) - [Deposit product updated](https://developers.pismo.io/events/docs/deposit-product-update-1.md) - [Program attached](https://developers.pismo.io/events/docs/deposit-product-program-attach-1.md) - [Account detached](https://developers.pismo.io/events/docs/deposit-product-account-detach-1.md) - [Account attached](https://developers.pismo.io/events/docs/deposit-product-account-attach-1.md) - [Deposit product registration confirmed](https://developers.pismo.io/events/docs/deposit-product-registration-confirmed-1.md) - [Deposit product registered](https://developers.pismo.io/events/docs/deposit-product-registration-success-1.md) - [Deposit product registration failed](https://developers.pismo.io/events/docs/deposit-product-registration-failure-1.md) - [Accrual event processed](https://developers.pismo.io/events/docs/deposit-product-accrual-event-success-1.md) - [Credit accrual processing failed](https://developers.pismo.io/events/docs/deposit-product-accrual-credit-failure-1.md) - [Credit accrual processed](https://developers.pismo.io/events/docs/deposit-product-accrual-credit-success-1.md) - [Deposit product withdrawal confirmation](https://developers.pismo.io/events/docs/deposit-product-withdrawal-confirmed-1.md) - [Deposit product withdrawal registration](https://developers.pismo.io/events/docs/deposit-product-withdrawal-success-1.md) - [Deposit product withdrawal registration](https://developers.pismo.io/events/docs/deposit-product-withdrawal-failure-1.md) - [Maturity instruction processing failed](https://developers.pismo.io/events/docs/deposit-product-maturity-instruction-failure-1.md) - [Maturity instruction processed](https://developers.pismo.io/events/docs/deposit-product-maturity-instruction-success-1.md) - [Capitalization payment processed](https://developers.pismo.io/events/docs/deposit-product-capitalization-payout-1.md) - [Capitalization credit processing failed](https://developers.pismo.io/events/docs/deposit-product-capitalization-failure-1.md) - [Capitalization credit processed](https://developers.pismo.io/events/docs/deposit-product-capitalization-success-1.md) - [Account attachment updated](https://developers.pismo.io/events/docs/deposit-product-account-attachment-updated-1.md) - [Deposit account opened](https://developers.pismo.io/events/docs/deposit-product-deposit-account-opened-1.md) - [External payout processed](https://developers.pismo.io/events/docs/deposit-product-external-payout-1.md) - [Maturity notice](https://developers.pismo.io/events/docs/deposit-product-maturity-notice-1.md) - [Program attachment updated](https://developers.pismo.io/events/docs/deposit-product-program-attachment-updated-1.md) - [Deposit renewed](https://developers.pismo.io/events/docs/deposit-product-renewal-1.md) - [Deposit account opened](https://developers.pismo.io/events/docs/deposit-product-unified-deposit-open-1.md) - [Interest accrual succeeded](https://developers.pismo.io/events/docs/interest-management-interest-accrual-success-1.md) - [Interest daily closure succeeded](https://developers.pismo.io/events/docs/interest-management-interest-daily-closure-success-1.md) - [Interest daily closure failed](https://developers.pismo.io/events/docs/interest-management-interest-daily-closure-failure-1.md) - [Interest registration succeeded](https://developers.pismo.io/events/docs/interest-management-interest-registration-success-1.md) - [Interest registration failed](https://developers.pismo.io/events/docs/interest-management-interest-registration-failure-1.md) - [Interest reconciliation succeeded](https://developers.pismo.io/events/docs/interest-management-interest-reconciliation-success-1.md) - [Interest reconciliation failed](https://developers.pismo.io/events/docs/interest-management-interest-reconciliation-failure-1.md) - [Interest redemption succeeded](https://developers.pismo.io/events/docs/interest-management-interest-redemption-success-1.md) - [Interest redemption failed](https://developers.pismo.io/events/docs/interest-management-interest-redemption-failure-1.md) - [Interest treasury confirmation succeeded](https://developers.pismo.io/events/docs/interest-management-interest-treasury-confirmation-success-1.md) - [Interest treasury confirmation failed](https://developers.pismo.io/events/docs/interest-management-interest-treasury-confirmation-failure-1.md) - [Interest redemption account succeeded](https://developers.pismo.io/events/docs/interest-management-interest-redemption-account-success-1.md) - [Quota status changed](https://developers.pismo.io/events/docs/interest-management-status-change-quota-1.md) - [Asset status changed](https://developers.pismo.io/events/docs/interest-management-status-change-asset-1.md) - [Asset status changed to completed](https://developers.pismo.io/events/docs/interest-management-status-change-completed-asset-1.md) - [Interest plan created](https://developers.pismo.io/events/docs/interest-management-interest-plan-creation-success-1.md) - [Interest deposit failed](https://developers.pismo.io/events/docs/interest-management-interest-deposit-failure-1.md) - [Interest deposit succeeded](https://developers.pismo.io/events/docs/interest-management-interest-deposit-success-1.md) - [Interest registration cancellation succeeded](https://developers.pismo.io/events/docs/interest-management-interest-registration-cancellation-success-1.md) - [Interest redemption cancellation succeeded](https://developers.pismo.io/events/docs/interest-management-interest-redemption-cancellation-success-1.md) - [Interest redemption cancellation failed](https://developers.pismo.io/events/docs/interest-management-interest-redemption-cancellation-failure-1.md) - [Interest registration cancellation failed](https://developers.pismo.io/events/docs/interest-management-interest-registration-cancellation-failure-1.md) - [Interest post-balance operation](https://developers.pismo.io/events/docs/interest-management-interest-post-balance-banking-1.md) - [Interest withdrawal failed](https://developers.pismo.io/events/docs/interest-management-interest-withdrawal-failure-1.md) - [Interest withdrawal succeeded](https://developers.pismo.io/events/docs/interest-management-interest-withdrawal-success-1.md) - [Interest accrual account succeeded](https://developers.pismo.io/events/docs/interest-management-interest-accrual-account-success-1.md) - [Interest account cancellation succeeded](https://developers.pismo.io/events/docs/interest-management-interest-account-cancellation-success-1.md) - [Interest account cancellation failure](https://developers.pismo.io/events/docs/interest-management-interest-account-cancellation-failure-1.md) - [Asset status changed to completed and uploaded to S3](https://developers.pismo.io/events/docs/interest-management-status-change-completed-asset-s3-1.md) - [Interest accrual succeeded and uploaded to S3](https://developers.pismo.io/events/docs/interest-management-interest-accrual-success-s3-1.md) - [Interest redemption failed](https://developers.pismo.io/events/docs/interest-management-interest-redemption-failure-2.md) - [Interest redemption succeeded](https://developers.pismo.io/events/docs/interest-management-interest-redemption-success-2.md) - [Interest registration failed](https://developers.pismo.io/events/docs/interest-management-interest-registration-failure-2.md) - [Interest registration succeeded](https://developers.pismo.io/events/docs/interest-management-interest-registration-success-2.md) - [Quota status changed](https://developers.pismo.io/events/docs/interest-management-status-change-quota-2.md) - [Quota status changed](https://developers.pismo.io/events/docs/interest-engine-interest-status-change-quota-1.md) - [Interest deposit succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-deposit-success-1.md) - [Interest account cancellation failure](https://developers.pismo.io/events/docs/interest-engine-interest-account-cancellation-failure-1.md) - [Interest account cancellation succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-account-cancellation-success-1.md) - [Asset status changed](https://developers.pismo.io/events/docs/interest-engine-interest-status-change-asset-1.md) - [Interest accrual succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-accrual-success-1.md) - [Deposit status changed to completed](https://developers.pismo.io/events/docs/interest-engine-interest-deposit-status-change-completed-1.md) - [Interest post-balance operation](https://developers.pismo.io/events/docs/interest-engine-interest-post-balance-banking-1.md) - [Interest deposit failed](https://developers.pismo.io/events/docs/interest-engine-interest-deposit-failure-1.md) - [Interest engine withdrawal failed](https://developers.pismo.io/events/docs/interest-engine-interest-withdrawal-failure-1.md) - [Interest engine withdrawal succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-withdrawal-success-1.md) - [Interest plan created](https://developers.pismo.io/events/docs/interest-engine-interest-plan-creation-success-1.md) - [Interest capitalization account succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-capitalization-account-success-1.md) - [Interest accrual account succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-accrual-account-success-1.md) - [Interest account update succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-account-update-success-1.md) - [Interest balance failed](https://developers.pismo.io/events/docs/interest-engine-interest-balance-failure-1.md) - [Interest balance succeeded](https://developers.pismo.io/events/docs/interest-engine-interest-balance-success-1.md) - [Interest plan updated](https://developers.pismo.io/events/docs/interest-engine-interest-plan-update-success-1.md) - [Bank account updated (deprecated)](https://developers.pismo.io/events/docs/intl-bankaccounts-bankaccount-update-1.md) - [Bank account registered](https://developers.pismo.io/events/docs/intl-bankaccounts-intl-bankaccount-register-1.md) - [Bank account updated](https://developers.pismo.io/events/docs/intl-bankaccounts-intl-bankaccount-update-1.md) - [Bank account registered (deprecated)](https://developers.pismo.io/events/docs/intl-bankaccounts-bankaccount-register-1.md) - [Judicial order account unblocked](https://developers.pismo.io/events/docs/judicial-order-account-unblock-1.md) - [Judicial order amount unblocked](https://developers.pismo.io/events/docs/judicial-order-amount-unblock-1.md) - [Judicial order account blocked](https://developers.pismo.io/events/docs/judicial-order-account-block-1.md) - [Judicial order amount blocked](https://developers.pismo.io/events/docs/judicial-order-amount-block-1.md) - [Overdraft product created](https://developers.pismo.io/events/docs/overdraft-product-creation-1.md) - [Overdraft account attached](https://developers.pismo.io/events/docs/overdraft-product-account-attach-1.md) - [Overdraft account detached](https://developers.pismo.io/events/docs/overdraft-product-account-detach-1.md) - [Overdraft program attached](https://developers.pismo.io/events/docs/overdraft-product-program-attach-1.md) - [Pix key status changed](https://developers.pismo.io/events/docs/pix-dict-key-status-change-1.md) - [Pix key claim status changed](https://developers.pismo.io/events/docs/pix-dict-claim-status-change-1.md) - [Pix DICT synchronized](https://developers.pismo.io/events/docs/pix-dict-synchronism-result-1.md) - [Pix refund status changed](https://developers.pismo.io/events/docs/pix-dict-refund-status-change-1.md) - [Pix infraction status changed](https://developers.pismo.io/events/docs/pix-dict-infraction-status-change-2.md) - [Pix infraction registration failure](https://developers.pismo.io/events/docs/pix-dict-infraction-registration-failure-1.md) - [Pix infraction close failure](https://developers.pismo.io/events/docs/pix-dict-infraction-close-failure-1.md) - [Pix infraction cancel failure](https://developers.pismo.io/events/docs/pix-dict-infraction-cancel-failure-1.md) - [Pix fraud marker registration failure](https://developers.pismo.io/events/docs/pix-dict-fraud-marker-registration-failure-1.md) - [Pix fraud marker registration](https://developers.pismo.io/events/docs/pix-dict-fraud-marker-registration-1.md) - [Pix fraud marker status change](https://developers.pismo.io/events/docs/pix-dict-fraud-marker-status-change-1.md) - [Pix fraud marker status change failure](https://developers.pismo.io/events/docs/pix-dict-fraud-marker-status-change-failure-1.md) - [Pix funds recovery status changed](https://developers.pismo.io/events/docs/pix-dict-funds-recoveries-status-change-1.md) - [Pix funds recovery operation failed](https://developers.pismo.io/events/docs/pix-dict-funds-recoveries-operation-failed-1.md) - [Pix-out reversed](https://developers.pismo.io/events/docs/pix-pix-out-reversal-1.md) - [Pix-out notification received](https://developers.pismo.io/events/docs/pix-pix-out-1.md) - [Pix reconciliation notification received](https://developers.pismo.io/events/docs/pix-financial-reconciliation-1.md) - [Pix-in reversed](https://developers.pismo.io/events/docs/pix-pix-in-reversal-1.md) - [Pix-in notification received](https://developers.pismo.io/events/docs/pix-pix-in-1.md) - [Collect a scheduled Pix-out signature notification](https://developers.pismo.io/events/docs/pix-pix-out-signature-1.md) - [Pix internal transaction reported](https://developers.pismo.io/events/docs/pix-pix-internal-transaction-report-1.md) - [Authorization](https://developers.pismo.io/events/docs/saga-authorization-1.md) - [Payment request updated](https://developers.pismo.io/events/docs/saga-payment-request-updated-1.md) - [Payment request created](https://developers.pismo.io/events/docs/saga-payment-request-created-1.md) - [Attach a program to a product](https://developers.pismo.io/events/docs/savings-account-product-program-attach-1.md) - [Attach an account to a product](https://developers.pismo.io/events/docs/savings-account-product-account-attach-1.md) - [Savings account product created](https://developers.pismo.io/events/docs/savings-account-product-creation-1.md) - [Detach an account from a product](https://developers.pismo.io/events/docs/savings-account-product-account-detach-1.md) - [Savings account product updated](https://developers.pismo.io/events/docs/savings-account-product-update-1.md) - [Savings account product registered](https://developers.pismo.io/events/docs/savings-account-product-registration-success-1.md) - [Savings account product registered](https://developers.pismo.io/events/docs/savings-account-product-registration-confirmed-1.md) - [Savings account product registration failed](https://developers.pismo.io/events/docs/savings-account-product-registration-failure-1.md) - [Credit accrual processing failed](https://developers.pismo.io/events/docs/savings-account-product-accrual-credit-failure-1.md) - [Credit accrual processed](https://developers.pismo.io/events/docs/savings-account-product-accrual-credit-success-1.md) - [Accrual event processed](https://developers.pismo.io/events/docs/savings-account-product-accrual-event-success-1.md) - [Savings account product withdrawal registration](https://developers.pismo.io/events/docs/savings-account-product-withdrawal-success-1.md) - [Savings account product withdrawal confirmation](https://developers.pismo.io/events/docs/savings-account-product-withdrawal-confirmed-1.md) - [Savings account product withdrawal registration](https://developers.pismo.io/events/docs/savings-account-product-withdrawal-failure-1.md) - [Capitalization credit processing failed](https://developers.pismo.io/events/docs/savings-account-product-capitalization-failure-1.md) - [Capitalization credit processed](https://developers.pismo.io/events/docs/savings-account-product-capitalization-success-1.md) - [UPI RuPay transaction created](https://developers.pismo.io/events/docs/upi-api-upi-rupay-1.md) - [Account operations status changed](https://developers.pismo.io/events/docs/lending-account-operations-hub-data-event-1.md) - [Insurance installment updated](https://developers.pismo.io/events/docs/lending-insurance-installment-update-1.md) - [Insurance updated](https://developers.pismo.io/events/docs/lending-lending-insurance-update-1.md) - [Loan updated](https://developers.pismo.io/events/docs/lending-lending-loan-update-1.md) - [Lending prepayment or group payment created](https://developers.pismo.io/events/docs/lending-lending-prepayment-v2-creation-1.md) - [Lending prepayment status changed](https://developers.pismo.io/events/docs/lending-lending-prepayment-v2-status-changed-1.md) - [Loan booked](https://developers.pismo.io/events/docs/lending-loan-booked-1.md) - [Loan disbursement status changed](https://developers.pismo.io/events/docs/lending-loan-disbursement-status-change-2.md) - [Loan product created](https://developers.pismo.io/events/docs/lending-loan-product-creation-3.md) - [Loan product updated](https://developers.pismo.io/events/docs/lending-loan-product-update-1.md) - [Minimum total payment delta applied](https://developers.pismo.io/events/docs/lending-minimum-total-payment-delta-applied-1.md) - [Prepayment created or status changed](https://developers.pismo.io/events/docs/lending-prepayment-creation-1.md) - [Loan repayment updated](https://developers.pismo.io/events/docs/lending-repayment-update-1.md) - [Lending error](https://developers.pismo.io/events/docs/lending-lending-error-1.md) - [Merchant created](https://developers.pismo.io/events/docs/merchants-merchant-created-1.md) - [Merchant transaction created](https://developers.pismo.io/events/docs/merchants-merchant-transaction-created-1.md) - [Merchant updated](https://developers.pismo.io/events/docs/merchants-merchant-updated-1.md) - [Merchant settlement not settled](https://developers.pismo.io/events/docs/merchants-merchant-settlement-not-settled-1.md) - [Merchant transaction settled](https://developers.pismo.io/events/docs/merchants-merchant-transaction-settled-1.md) - [Merchant advancement transaction created](https://developers.pismo.io/events/docs/merchants-advancement-transaction-create-1.md) - [Merchant advancement request created](https://developers.pismo.io/events/docs/merchants-advancement-request-1.md) - [Merchant transaction settled](https://developers.pismo.io/events/docs/merchants-merchant-transaction-settled-2.md) - [Merchant settlement created](https://developers.pismo.io/events/docs/merchants-merchant-settlement-created-2.md) - [Merchant settlement created](https://developers.pismo.io/events/docs/merchants-merchant-settlement-created-1.md) - [Marketplace creditor operation updated](https://developers.pismo.io/events/docs/marketplace-marketplace-creditor-operation-updated-1.md) - [Marketplace creditor operation created](https://developers.pismo.io/events/docs/marketplace-marketplace-creditor-operation-created-1.md) - [Marketplace updated](https://developers.pismo.io/events/docs/marketplace-marketplace-updated-1.md) - [Merchant head branch relationship disabled](https://developers.pismo.io/events/docs/marketplace-head-branch-relationship-disabled-1.md) - [Merchant head branch relationship created](https://developers.pismo.io/events/docs/marketplace-head-branch-relationship-created-1.md) - [Marketplace created](https://developers.pismo.io/events/docs/marketplace-marketplace-created-1.md) - [Marketplace creditor operation deleted](https://developers.pismo.io/events/docs/marketplace-marketplace-creditor-operation-deleted-1.md) - [Marketplace created](https://developers.pismo.io/events/docs/marketplace-marketplace-created-2.md) - [Marketplace updated](https://developers.pismo.io/events/docs/marketplace-marketplace-updated-2.md)