For AI agents: visit https://developers.pismo.io/pismo-docs/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Sub-processors About Pismo Contact us

APIs

Sub-processors About Pismo Contact us

Home Guides APIs Changelog Events

Get started

Get started with Pismo APIs
Get an account-specific token
Rate limiting on the Pismo platform

Platform authentication

Authentication

Platform setup - Organizations

Orgs
- Update organizationpatch
- Get organizationget
Holidays (deprecated)

Platform setup - Programs

Programs
Parameters
Export and import

Platform setup - Holidays

Holiday calendar
Holiday calendar data
Holidays (deprecated)
Holidays v2 - Transaction banking (deprecated)

Platform setup - Divisions

Administrative divisions (deprecated)
Administrative divisions V2 (deprecated)

Platform setup - Rates and fees

Fee models
Simulation
Exchange rates
- Create exchange ratepost
- Get exchange ratesget

Platform setup - Orgs operation

Reversal processing codes
- Create reversal processing codepost
Processing codes

Core platform - Ledger

Account limits
- List account limitsget
- Update account limits (outdated)patch

Core platform - Accounts

Accounts
Account parameters
Customers
Addresses
Phones
Statuses and reasons
Transfer account
- Transfer account to different programpost

Core platform - Accounting

Accounting event types
- List accounting event typesget
- Get accounting event typeget
Accounting entry types
Accounting accounts
Accounting scripts V2
Accounting scripts V1
Accounting entry
- Create accounting entrypost
Buckets
- Get account bucketsget

Core platform - Accumulator

Configuration
Accumulators
- List account accumulatorsget

Core platform - Balances and limits

Related accounts
- Get related accountsget
Account balances
- Get daily account balance limitsget
Program limits
Account limits
- Update account limitspatch

Core platform - Balance configurations

Balance configurations
Filter templates

Core platform - Balance watcher

Limit configurations
Limit acceptance configurations

Core platform - Flex controls

Account flex controls
Customer flex controls
Program flex controls
- List program flex controlsget
Attribute groups

Core platform - Payment methods

Payment methods
Payments
- Transfer fundspost
- Cancel transfer fundspost
Force operations
- Force operationpost
- Cancel forced operationpost
Hold funds
Payment requests
- Create payment requestpost
- List payment requestsget
Installments payments
- Create installments paymentpost
- Cancel installments paymentpost

Core platform - Payment methods admin

Simulation
- Create simulationpost

Core platform - Payment scheduler

Schedules

Core platform - Payment configurations

Payment method configurations
Payment method acceptances

Core platform - Rule models

Model
Model list
Apply

Core platform - Transactions

Transaction types
Transaction flows
Transactions

Control Center

Audit
- List audit recordsget

Banking - Transaction banking

Hierarchies
Divisions
Accounts
Bank statements
Payments
Payments (Pismo account ID)
Earmarking (external accounts)
Earmarking (Pismo account ID)
Channels
Check posting
Dormancy
Transactions
Bulk payment files
Bulk settlement
- Request bulk settlementpost
Operations blocks
Register banking account
- Register banking accounts with transaction bankingpost
Restricted funds

Banking - Bank accounts

Bank accounts
Beneficiaries

Banking - Assets

Assets
Quotas
- Update quotapatch
- List asset quotasget

Banking - TED configuration

Configurations
- Register for TED transferspost

Banking - Credit receivables

Receivable
Invoices
- Get invoiceget

Banking - Funds coverage

Protection sources

Banking - Integrated payments

Bank slip issuance
Bank slip
Transfer
- Perform cash-outpost
- List transferget
eBill registration

Banking - Authentication

Provider credentials
- Create provider credentialpost

Banking - Interest-bearing accounts

Average balance
- Calculate average balancepost
- Get average balanceget
Account attachment
Deposit account lifecycle
- Get cycle snapshot for deposit accountget
Penalty
- Simulate penaltypost
Product
Deposit account open
- Open deposit accountpost
Program attachment

Banking - Interest operations

Interest engine

Banking - Interest engine

Account interest
- Get account interestget
- Update account interestput
Benchmark rate
Interest accrual
- Configure timing for accrual calculationpost
Interest engine

Banking - Overdraft

Product
- Create overdraft productpost
- Get overdraft productget
Account
Program
- Attach overdraft product to programpost

Instant payments - Automatic Pix

Automatic Pix
Automatic Pix data

Instant payments - Pix management

Keys
Claims
Infraction reports
Funds recovery
Anti-fraud
Refunds
Participants
- List Pix participantsget

Instant payments - Pix payments

Pix
Scheduled transfers V2
Scheduled transfers
Withdrawal services
- Validate bank as withdrawal servicerpost
- Get withdrawal service agent informationget

Instant payments - QR Code

QR Code
Recurring payment

Instant payments - BR Code

BR Code
- Encode BR Codepost
- Decode BR Codepost

Instant payments - RuPay on UPI

UPI

Instant payments - Faster payments

Faster payments

Payment rails - BACS payments

BACS direct credit
BACS direct debit

Card issuing - Authorization

Authorizations

Card issuing - Authorization configurations

Authorization configurations

Card issuing - Cards

Cards
Card reissue
Card status
Card validity
- Renew card validitypatch
- Delete card validity perioddel
PCI
Noname
Embossing
Embossing data
Embossing encrypted
Modes
Templates
- Get card templateget
- List card templatesget
Issuer PAN/PIN
- Update nominal card PAN/PIN [beta]put
- Update noname card PAN/PIN [beta]put
Migration
- Migrate card to different program [beta]patch
- Migrate card mode [beta]patch
Mastercard benefits
CVV rotation
Automatic updater
- Automatic updater opt-outpost
- Visa automatic updater opt-inpost

Card issuing - 3DS authentication

HST
Pre-authentication
- Send pre-authentication infopost
VCAS

Card issuing - Tokenization

Network card profile
Pre-digitalization
Token lifecycle
Card lifecycle
Visa Click to Pay
MDES Token Connect [Beta]

Card issuing - Disputes

Disputes
Installments
- Create dispute installmentpost
- Get dispute installmentget
Evidence files
Supporting forms
Fraud report
State check
- Get possible dispute statesget
- Get possible statesget
Fees
Fees V2
- Create fee V2post
- Get fee V2get
Migration
On-Us
- Create on-us disputepost
- Update on-us disputepost

Card issuing - Cards on file

Cards on file
Validation
Metadata
- Delete card metadatadel

Card issuing - Protection Bulletin

Bulletin
Rules
- Create Protection Bulletin rulepost
- Get Protection Bulletin ruleget

Card issuing - Reconciliation

Network transactions backoffice
- Perform clearing reconciliationpost

Pismo clearing rules engine

Clearing rules
- Get latest clearing rules configurationget
- Update clearing rules configurationput

Card issuing - Visa Flexible Credentials [beta]

Enrollment
Relationships
Rules

Revolving credit - Configurations

Program transaction types
- Create program transaction typepost
Account accrual rates
Program accrual rates
Features by account status
Additional accrual type configurations
- Enable additional configurations on accrual typespost
- Disable additional configuration on accrual typesdel
Transaction accrual rates

Revolving credit - Recurring charges

Recurring charge plans
Recurring charge links
Recurring scheduled charges

Revolving credit - Calendar management

List calendars
- List calendarsget
Program calendar strategies
Account calendar strategies
- Get account calendar strategyget
- Update account calendar strategyput
Close account cycle
- Close account cyclepost

Revolving credit - Statement refinancing

Payment agreement simulation
- Create payment agreement simulationpost
- Get payment agreement simulationget

Revolving credit - Delinquent account

Delinquent account closure
- Get delinquent account closure process informationget
- Close delinquent accountpost

Revolving credit - Delinquency

Delinquency
- Get delinquency bucketget
- List delinquency bucketsget

Revolving credit - Installment management

Installment advancements
Simulations
- Simulate installment advancementget

Revolving credit - Interest accruals

Post interest accruals
- Post interest accrualspost
Accrual types minimum value
Accrual type post configurations

Revolving credit - Statements

Account
- Update account collection statuspatch
Account transaction categories
Accruals
Advancements
Discharge tracking
- List dischargesget
Due date
Statement minimum amount due
Refinancing
Program transaction categories
Statement
Transaction shift
- Shift transactionspost
- Get transaction shiftget
Multivalue program parameters
Transaction types

Data and reporting - Timeline

Timeline
- List account timeline eventsget

Seller management - Merchants

Merchant
Merchant creditor
Merchant transaction
Merchant business category
- List business categoriesget
- Get business categoryget
Merchant advancement

Seller management - Merchant advancements

Merchant advancement
Merchant advancement transaction
- List transactionsget

Seller management - Sellers

Settlement actions
Settlements
- List advancement requests settledget
Marketplace
Marketplace merchants links

Seller management - Transactions

Split requests
Balance
- Get merchant balanceget
Merchant transactions
- Create merchant transactionpost
- Cancel merchant transactionpost

Seller management - Marketplace

Marketplace
- Get marketplace V2 (deprecated)get
- List marketplaces V1 (deprecated)get
Marketplace creditor operations
Marketplace MDR tax
Marketplace merchants links

Migrations

Account migration
Accrual migration
- Migrate accrualspost
Authorization migration
- Migrate authorizationspost
Balance migration
- Migrate balancespost
Card migration
- Migrate cardspost
- Migrate PCI cardspost
Customer migration
- Migrate customerspost
Dispute migration
- Migrate disputespost
Delinquency bucket migration
- Start migration of delinquency bucketspost
Fee model migration
- Migrate account fee modelspost
Merchant migration
- Migrate merchantspost
Merchant transaction migration
- Migrate merchant transactionspost
On-us authorization migration
- Migrate on-us authorizationspost
Statement migration
- Migrate statementspost
Token migration
- Migrate tokenspost
Transaction migration
- Migrate transactionspost
Recurring charge plan migration
- Migrate recurring charge planspost
Recurring charge link migration
- Migrate recurring charge linkspost

Lending

Loan products
Loans
Disbursements
- Disburse loanpost
Repayments
- Register repaymentpost
Early final settlement
- Simulate early final settlementpost
- Register early final settlementpost
Prepayment
Repayment hierarchy
- Create repayment hierarchypost
- Get repayment hierarchyget

Banking - Interest management for B3-listed products

Interest plan
- Create interest plan for B3-listed productspost
- Get interest plan for B3-listed productsget
Account interest
- Get account interest for B3-listed productsget
- Update account interest for B3-listed productsput
Benchmark rate