Jump to Content
Release Notes
Portal Guide
API Guide
Documentation
Release Notes
Portal Guide
API Guide
Documentation
Documentation
Search
CPX API Guide
API User Guide
Getting Started
Working with API
Changes in This Version
1. Institution
Create Institution
Update Institution
Retrieve Institution by Id
Retrieve Institution by Custom field
Retrieve List of Institutions
2. Institution Buyer Relationships
Retrieve list of Institution buyer relationships
Retrieve list of Institution buyer relationships for Export
3. Custom Pifs
Create PIF
Update PIF
Delete PIF
Get Custom PIF
Get list of custom pif mappings
4. Institution Fee
Update Fee for Institution
Retrieve Fee for Institution
5. Buyer
Create Buyer
Update Buyer
Retrieve Buyer by Id
Retrieve Buyer By Id for Export
Retrieve Buyer by Custom field
Delete Buyer
Update Exposure Tracking Data for Buyer
6. Buyer Bank Account
Create Bank account for a Buyer
Retrieve Bank account by Token
Retrieve all Bank accounts for a Buyer
Delete Bank Account
Update default Bank account for a Buyer product
Get default Bank account for a Buyer product
Create Check Account for Buyer
Get Check account for a Buyer by Token
Delete Check account for a Buyer by Token
Update Check account for a Buyer by Token
Assign Signature
Confirm Check Account
Verify Microdeposit
Approve Check Proof for a Check Account
Reject Check Proof for a Check Account
Retrieve Check Proof for a Check Account
Activate Check Account
Deactivate Check Account
Update Critical Check Account Info
Enable Account for Passport
Confirm Account to enable Bank Account for Passport
Verify Micro deposit to enable Bank Account for Passport
7. Buyer Supplier Association
Create Buyer Supplier Association
Update Buyer Supplier Association
Retrieve Buyer Supplier Associations by Custom Fields
Retrieve Buyer Supplier Associations For Export
Delete Buyer Supplier Associations
8. Buyer Cards
Create Card
Delete Card
Update Card
Get Card List
Get Card data using card entity Id
9. Buyer Rules for PlastiqPay
Create Rule
Delete rule by id
Delete criteria by id
Update Rule
Search Rule
Search Rule List
10. Buyer Fees
Update Fee for Buyer
Retrieve Fee for Buyer
11. Funding Account
Delete Funding Account for Buyer
12. Card Management Rules
Delete Card Management Rules for Buyer
13. Supplier
Create Supplier
Update Supplier
Retrieve Supplier by Id
Retrieve Supplier for Export
Retrieve Supplier by Custom Field
Retrieve Supplier Autocomplete
Delete Supplier
Create Suppliers from CSV
Read Suppliers from CSV
Send PIN for Suppliers
Resend PIN for Suppliers
Update PIN for Suppliers
14. Payments
Create Payments
Cancel Payment
Get list of Payments
Get list of Payments for a Supplier
Get list of Payments for Export
Get list of Payments for a supplier for Export
Decrypt Card Data for Payment
Get VCN Expiration for a card
Cancel VCN card
Get Settlement Data for a Payment
Search all payments from a transactionId
Get Payments with Card Token
Get list of Payments for a Buyer for Export
Gets the Payment Status History of a Payment for export
Gets the Payment Status History of a Payment
Get Fail Over Transactions for the given Transaction Id
15. Monetary Adjustment
Create Adjustment
16. Buyer Wallet
Add Money
Withdraw Money
Get Wallet Transactions
17. Invoices
Search invoices
Search invoices by Transaction ID
Search invoices for a Supplier
Search invoices for a Supplier For export
18. Reports
Get ACH Fee Report for Institution
19. Files
Search Files
Search Files for Export
Approve/Reject PIF Files
Post PIF Files in CSV format
Cancel all transactions in PIF File
20. Product Ids for Galileo
Add new Product Ids
Retrieve Products Configured
Suggest
