Jump to Content

API Reference Status Page

Home Guides API Reference

API Reference Status Page Log In

API Reference

Home Guides API Reference

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
Payments
Post Transactions to File
/buyer/{id}/export
- Gets all payments from a Buyerget
/paymentStatusHistory/{id}/export
- Gets the Payment Status History of a Payment for exportget
/paymentStatusHistory/{id}
- Gets the Payment Status History of a Payment for the given Payment Idget
/failOverTransactions/{id}
- Get Fail Over Transactions for the given Transaction Idget
Payment Email
- Get pif transactionsget

CPX Invoice API

Invoice

CPX Network API

General
Network
Relationships
- Search network/institution relationshipget
- Search network/institution relationship for exportget

CPX Institution API

General
Institution
Relationships
- Search institution/buyer relationshipget
- Search institution/buyer relationship for exportget

CPX Buyer API

General
Buyer
Relationships

CPX Payee API

General
Payee
Post Payees
- Create Payeespost
Post Payees Template
- Read Payee Upload Templatepost
Security Pin
/payeesAddedNotification
- Sends supplier added notificationspost

CPX File API

General
File
Post Transactions to File
- Post PIF File in CSV Formatpost
/paymentFailure
- Dispatch emails for failed transactions.post
/paymentFileAwaitingApproval
- Dispatch emails for payment file awaiting ppproval transactions.post
Expire
- Cancel all transactions in a filepost

CPX Report API

General
Reports
- Get ACH Fee Report for Institutionget

CPX User API

General
Users
Filters
/userFeatures
- Create Feature Flagpost
/features
- This route will get all feature flagsget
- Create Feature Flagpost
/features/{id}

CPX Widget API

General
Widgets

CPX Alert API

/alert
- Send institution alertspost

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
Payments
Post Transactions to File
/buyer/{id}/export
- Gets all payments from a Buyerget
/paymentStatusHistory/{id}/export
- Gets the Payment Status History of a Payment for exportget
/paymentStatusHistory/{id}
- Gets the Payment Status History of a Payment for the given Payment Idget
/failOverTransactions/{id}
- Get Fail Over Transactions for the given Transaction Idget
Payment Email
- Get pif transactionsget

CPX Invoice API

Invoice

CPX Network API

General
Network
Relationships
- Search network/institution relationshipget
- Search network/institution relationship for exportget

CPX Institution API

General
Institution
Relationships
- Search institution/buyer relationshipget
- Search institution/buyer relationship for exportget

CPX Buyer API

General
Buyer
Relationships

CPX Payee API

General
Payee
Post Payees
- Create Payeespost
Post Payees Template
- Read Payee Upload Templatepost
Security Pin
/payeesAddedNotification
- Sends supplier added notificationspost

CPX File API

General
File
Post Transactions to File
- Post PIF File in CSV Formatpost
/paymentFailure
- Dispatch emails for failed transactions.post
/paymentFileAwaitingApproval
- Dispatch emails for payment file awaiting ppproval transactions.post
Expire
- Cancel all transactions in a filepost

CPX Report API

General
Reports
- Get ACH Fee Report for Institutionget

CPX User API

General
Users
Filters
/userFeatures
- Create Feature Flagpost
/features
- This route will get all feature flagsget
- Create Feature Flagpost
/features/{id}

CPX Widget API

General
Widgets

CPX Alert API

/alert
- Send institution alertspost

Get PIF Mapping by id

get https://api.cpxenterprise.com/institution/v1/pifMapping/{id}

Returns a Custom PIF Mapping

Language

Credentials

Header

Click Try It! to start a request and see the response here!