JUMP TOUpcoming ChangesBuyer Bank Account MaintenanceInstitution Bank Account MaintenanceSupplier FAX typeAPI OverviewIntroductionAPI Key Authentication InstructionsAuthentication using JWTCommon API RoutesCPX Payment APIGeneralAbout this API.getHealth status check for this APIgetRetrieve the swagger documentation for this API.getPaymentsSearch paymentsgetSearch payments for exportgetGets all payments from a suppliergetGets all payments from a supplier for exportgetDecrypts account datagetGet VCN expirationpostReverts expired paymentpostCancel cardpostCancel PaymentpostSearch for dispositiongetGets settlement datagetGets all payments from a transactionIdgetPost Transactions to FilePost PIF Transactions in JSON FormatpostPost PIF Transactions in CSV FormatpostPost PIF Transactions in JSON Formatpost/buyer/{id}/exportGets all payments from a Buyerget/paymentStatusHistory/{id}/exportGets 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 IdgetPayment EmailGet pif transactionsgetCPX Invoice APIInvoiceSearch invoicesgetGet all invoices for a supplier by transaction idgetGet all invoices for a suppliergetGet all invoices for a supplier for exportgetCPX Network APIGeneralAbout This APIgetHealth CheckgetRetrieve the swagger documentation for this APIgetNetworkSearch networks for exportgetSearch networksgetCreate networkpostSearch Network AutocompletegetGets a specific networkgetUpdate a networkputDelete a networkdeleteRelationshipsSearch network/institution relationshipgetSearch network/institution relationship for exportgetCPX Institution APIGeneralAbout This APIgetHealth CheckgetRetrieve the swagger documentation for this APIgetInstitutionSearch InstitutionsgetCreate InstitutionpostSearch Institutions for exportgetSearch Institution AutocompletegetList all institutionsgetGets a specific InstitutiongetUpdate InstitutionputDelete InstitutiondeleteCreate or update prodIdpostDelete prodIddeleteGet list of custom pif mappings for institutiongetCreate a custom pif mapping for institutionpostGet PIF Mapping by idgetUpdate Custom PIF MappingputDelete Custom PIF MappingdeleteRelationshipsSearch institution/buyer relationshipgetSearch institution/buyer relationship for exportgetCPX Buyer APIGeneralAbout this APIgetHealth status check for this APIgetRetrieve the swagger documentation for this APIgetBuyerSearch buyers for exportgetSearch buyersgetCreate buyerpostGet Buyer by idgetUpdate buyerputDelete buyerdeleteGet default bank account for a buyer productgetUpdate default bank account for a buyer productputGet bank accountgetDelete bank account by tokendeleteGet bank accounts for a buyergetCreate bank accountpostCreate Check AccountpostGet Check Account by Token idgetDelete Check AccountdeleteUpdate Check AccountpostAssign Check Account SignaturepostConfirm Check AccountpostVerify Micro DepositpostGet check proof imagegetApprove Check ProofpostReject Check ProofpostActivate Check AccountpostDeactivate Check AccountpostUpdate critical check account infopostUpdate Exposure Tacking Data for BuyerpostRelationshipsSearch buyer/supplier relationship for exportgetSearch buyer/supplier relationshipgetCreate buyer/supplier relationshippostUpdate buyer/supplier relationshipputDelete buyer/supplier relationshipdeleteCPX Payee APIGeneralAbout this APIgetHealth status check for this APIgetRetrieve the swagger documentation for this APIgetPayeeSearch Payees for exportgetSearch PayeesgetCreate PayeepostSearch payees autocompletegetGet payeegetUpdate PayeeputDelete PayeedeleteSearch Identity Verification History for given Payee for exportgetSearch Identity Verification History for given PayeegetPost PayeesCreate PayeespostPost Payees TemplateRead Payee Upload TemplatepostSecurity PinSend pin emailpostResend pin emailpostUpdate Payee Pinput/payeesAddedNotificationSends supplier added notificationspostCPX File APIGeneralAbout This APIgetHealth CheckgetSwagger DocumentationgetFileSearch files for exportgetSearch filesgetAppprove or Deny PIF FIlespostPost Transactions to FilePost PIF File in CSV Formatpost/paymentFailureDispatch emails for failed transactions.post/paymentFileAwaitingApprovalDispatch emails for payment file awaiting ppproval transactions.postExpireCancel all transactions in a filepostCPX Report APIGeneralAbout this APIgetHealth status check for this APIgetRetrieve the swagger documentation for this API.getReportsGet ACH Fee Report for InstitutiongetCPX User APIGeneralAbout this APIgetHealth CheckgetSwagger DocumentationgetUsersSearch Users for exportgetSearch UsersgetCreate UserpostUpdate Current UserputGet usergetUpdate UserputDelete UserdeleteFiltersCreate User FilterpostGet Filter ListgetDelete Filterdelete/userFeaturesCreate Feature Flagpost/featuresThis route will get all feature flagsgetCreate Feature Flagpost/features/{id}This route will get a feature togglegetThis route will update a feature toggleputThis route will get a feature toggledeleteCPX Widget APIGeneralAbout this APIgetHealth status check for this APIgetSwagger Doc - WidgetgetWidgetsAverage PaymentgetPayments By TypegetTop Paid SuppliersgetTop Paid MCCgetTotal PaymentsgetVolume Over TimegetSupplier By TypegetCPX Alert API/alertSend institution alertspostSupplier FAX typeUpdate to Supplier Payment Types A new payment method has been added to the supplier settings payment types: Fax. This type takes one field only which is the fax number field. JSON"paymentTypes": [ { "enabled": true, "fax": 8989889898 //Fax number is required "type": "Fax" } ]
