Jump to Content
API Reference
Status Page
Home
Guides
API Reference
v1.0.0
v1.1
API Reference
Status Page
Log In
API Reference
Log In
v1.0.0
Home
Guides
API Reference
Retrieve the swagger documentation for this API.
Search
JUMP TO
Upcoming Changes
Buyer Bank Account Maintenance
Institution Bank Account Maintenance
Supplier FAX type
API Overview
Introduction
API Key Authentication Instructions
Authentication using JWT
Common API Routes
CPX Payment API
General
About this API.
get
Health status check for this API
get
Retrieve the swagger documentation for this API.
get
Payments
Search payments
get
Search payments for export
get
Gets all payments from a supplier
get
Gets all payments from a supplier for export
get
Decrypts account data
get
Get VCN expiration
post
Reverts expired payment
post
Cancel card
post
Cancel Payment
post
Search for disposition
get
Gets settlement data
get
Gets all payments from a transactionId
get
Post Transactions to File
Post PIF Transactions in JSON Format
post
Post PIF Transactions in CSV Format
post
Post PIF Transactions in JSON Format
post
/buyer/{id}/export
Gets all payments from a Buyer
get
/paymentStatusHistory/{id}/export
Gets the Payment Status History of a Payment for export
get
/paymentStatusHistory/{id}
Gets the Payment Status History of a Payment for the given Payment Id
get
/failOverTransactions/{id}
Get Fail Over Transactions for the given Transaction Id
get
Payment Email
Get pif transactions
get
CPX Invoice API
Invoice
Search invoices
get
Get all invoices for a supplier by transaction id
get
Get all invoices for a supplier
get
Get all invoices for a supplier for export
get
CPX Network API
General
About This API
get
Health Check
get
Retrieve the swagger documentation for this API
get
Network
Search networks for export
get
Search networks
get
Create network
post
Search Network Autocomplete
get
Gets a specific network
get
Update a network
put
Delete a network
delete
Relationships
Search network/institution relationship
get
Search network/institution relationship for export
get
CPX Institution API
General
About This API
get
Health Check
get
Retrieve the swagger documentation for this API
get
Institution
Search Institutions
get
Create Institution
post
Search Institutions for export
get
Search Institution Autocomplete
get
List all institutions
get
Gets a specific Institution
get
Update Institution
put
Delete Institution
delete
Create or update prodId
post
Delete prodId
delete
Get list of custom pif mappings for institution
get
Create a custom pif mapping for institution
post
Get PIF Mapping by id
get
Update Custom PIF Mapping
put
Delete Custom PIF Mapping
delete
Relationships
Search institution/buyer relationship
get
Search institution/buyer relationship for export
get
CPX Buyer API
General
About this API
get
Health status check for this API
get
Retrieve the swagger documentation for this API
get
Buyer
Search buyers for export
get
Search buyers
get
Create buyer
post
Get Buyer by id
get
Update buyer
put
Delete buyer
delete
Get default bank account for a buyer product
get
Update default bank account for a buyer product
put
Get bank account
get
Delete bank account by token
delete
Get bank accounts for a buyer
get
Create bank account
post
Create Check Account
post
Get Check Account by Token id
get
Delete Check Account
delete
Update Check Account
post
Assign Check Account Signature
post
Confirm Check Account
post
Verify Micro Deposit
post
Get check proof image
get
Approve Check Proof
post
Reject Check Proof
post
Activate Check Account
post
Deactivate Check Account
post
Update critical check account info
post
Update Exposure Tacking Data for Buyer
post
Relationships
Search buyer/supplier relationship for export
get
Search buyer/supplier relationship
get
Create buyer/supplier relationship
post
Update buyer/supplier relationship
put
Delete buyer/supplier relationship
delete
CPX Payee API
General
About this API
get
Health status check for this API
get
Retrieve the swagger documentation for this API
get
Payee
Search Payees for export
get
Search Payees
get
Create Payee
post
Search payees autocomplete
get
Get payee
get
Update Payee
put
Delete Payee
delete
Search Identity Verification History for given Payee for export
get
Search Identity Verification History for given Payee
get
Post Payees
Create Payees
post
Post Payees Template
Read Payee Upload Template
post
Security Pin
Send pin email
post
Resend pin email
post
Update Payee Pin
put
/payeesAddedNotification
Sends supplier added notifications
post
CPX File API
General
About This API
get
Health Check
get
Swagger Documentation
get
File
Search files for export
get
Search files
get
Appprove or Deny PIF FIles
post
Post Transactions to File
Post PIF File in CSV Format
post
/paymentFailure
Dispatch emails for failed transactions.
post
/paymentFileAwaitingApproval
Dispatch emails for payment file awaiting ppproval transactions.
post
Expire
Cancel all transactions in a file
post
CPX Report API
General
About this API
get
Health status check for this API
get
Retrieve the swagger documentation for this API.
get
Reports
Get ACH Fee Report for Institution
get
CPX User API
General
About this API
get
Health Check
get
Swagger Documentation
get
Users
Search Users for export
get
Search Users
get
Create User
post
Update Current User
put
Get user
get
Update User
put
Delete User
delete
Filters
Create User Filter
post
Get Filter List
get
Delete Filter
delete
/userFeatures
Create Feature Flag
post
/features
This route will get all feature flags
get
Create Feature Flag
post
/features/{id}
This route will get a feature toggle
get
This route will update a feature toggle
put
This route will get a feature toggle
delete
CPX Widget API
General
About this API
get
Health status check for this API
get
Swagger Doc - Widget
get
Widgets
Average Payment
get
Payments By Type
get
Top Paid Suppliers
get
Top Paid MCC
get
Total Payments
get
Volume Over Time
get
Supplier By Type
get
CPX Alert API
/alert
Send institution alerts
post
Retrieve the swagger documentation for this API.
get
https://api.cpxenterprise.com/report/v1/swagger
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
