v1.0.0
OpenAPI 3.1.1
Positive Pay API
Overview
Welcome to the interactive API documentation for Positive Pay! Before you begin, please ensure you’ve read through the API Guide.
Portal Access
AFS Support will create your UAT and Production accounts. You can access your Positive Pay accounts through these portals:
Base URLs
Use the following base URLs when configuring your application:
Authentication
Positive Pay requires an API token to authenticate requests. Include your token in the request header using:
Authorization: Bearer <UAT_API_TOKEN>
You can view and manage your API tokens here:
Client Libraries
Shell Curl
Webhook (Collapsed)
User (Collapsed)
Template (Collapsed)
Template Operations
- post/template/AddUpdateCustomTemplate
- get/template/CustomTemplates
- post/template/DefaultTemplates
- get/template/DeleteCustomTemplate/{id}
- get/template/GetCustomTemplate/{id}
- get/template/GetDefaultTemplate/{id}
- get/template/GetEmailContainer
- get/template/RestoreEmailContainer
- post/template/SendTestNotification
- post/template/UpdateEmailContainer
Security (Collapsed)
Security Operations
- post/security/AddUpdateRole
- post/security/CompleteResetPassword
- get/security/DeactivateUser/{clientId}/{userId}
- get/security/DeleteRole/{id}
- post/security/EmailExists
- get/security/GenerateUserApiToken/{clientId}/{userId}
- get/security/GetAccountEntitlements/{id}
- get/security/GetRole/{id}
- get/security/GetUser/{clientId}/{userId}
- get/security/GetUserApiToken/{clientId}/{userId}
- post/security/InactiveUsersByClient/{clientId}
- post/security/PasswordAlreadyUsed/{clientId}
- post/security/PermissionDetails
- get/security/ReactivateUser/{clientId}/{userId}
- post/security/Roles
- get/security/RolesByClient/{clientId}
- post/security/SendForgotPasswordEmail
- get/security/SendWelcomeEmail/{clientId}/{userId}
- get/security/TestEmail/{clientId}/{userId}
- post/security/UsersByClient/{clientId}
- get/security/UsersByEvent
Rule (Collapsed)
Rule Operations
- post/rule/AchApprovalRules/{clientId}
- post/rule/AchDecisionRules/{clientId}
- post/rule/AddCompany/{clientId}
- post/rule/AddPayee/{clientId}
- post/rule/AddUpdateRule
- post/rule/BulkImport/{clientId}
- get/rule/BulkSchema/{Kind}
- post/rule/CheckApprovalRules/{clientId}
- post/rule/CheckDecisionRules/{clientId}
- post/rule/Companies
- get/rule/DeleteCompany/{id}
- get/rule/DeletePayee/{id}
- get/rule/DeleteRule/{id}
- get/rule/GetRule/{id}
- post/rule/ParseBulkFile/{clientId}
- get/rule/PayeeNames/{clientId}
- post/rule/PayeeOptions/{clientId}
- post/rule/Payees
- post/rule/RuleExists
- post/rule/UpdateCompany
- post/rule/UpdatePayee
Mfa (Collapsed)
Mfa Operations
- get/mfa/AuthenticatorEnrollQr
- post/mfa/AuthenticatorEnrollStart
- post/mfa/AuthenticatorEnrollVerify
- post/mfa/ChallengePendingStatus
- post/mfa/ChallengeStart
- get/mfa/ChallengeStatus
- post/mfa/OnboardingStart
- get/mfa/OnboardingStatus
- post/mfa/OnboardingVerify
- post/mfa/ProfileChallengeStart
- post/mfa/ProfileVerify
- post/mfa/RevokeAuthenticator
- post/mfa/RevokeTrustedDevice
- post/mfa/SendOtp
- post/mfa/UserReset
- post/mfa/VerifyAuthenticator
- post/mfa/VerifyOtp
Holiday (Collapsed)
File (Collapsed)
File Operations
- post/file/AddUpdateFileFormat
- post/file/ClientFileUploads
- get/file/DeleteFileFormat/{id}
- get/file/DeleteUploadedFile/{id}
- post/file/FileFormats
- post/file/FileUploadBadRecords/{fileUploadId}
- post/file/FileUploads/{categoryId}
- get/file/GetFileFormat/{id}
- post/file/HeaderExists/{categoryId}/{formatId}
- get/file/HideFileFormat/{id}
- post/file/UploadFile/{id}
- get/file/UploadFileBankAccountOptions/{clientId}
- get/file/UploadFileFormatOptions
Exceptions (Collapsed)
Exceptions Operations
- get/exceptions/ACHExceptionView/{id}
- post/exceptions/ApprovalHistory
- get/exceptions/ApprovalView/{name}/{id}
- post/exceptions/ApproveACHDecision
- post/exceptions/ApproveCheckDecision
- post/exceptions/AssignToBusinessClient
- get/exceptions/CheckExceptionView/{id}
- post/exceptions/ExceptionHistory
- post/exceptions/ManualACHDecision
- post/exceptions/ManualCheckDecision
- post/exceptions/MarkAsReviewed
- get/exceptions/OpenACHApproval/{id}
- get/exceptions/OpenACHException/{id}
- post/exceptions/OpenApprovalList
- get/exceptions/OpenApprovals/{id}
- get/exceptions/OpenCheckApproval/{id}
- get/exceptions/OpenCheckException/{id}
- post/exceptions/OpenExceptionList
- get/exceptions/OpenExceptions/{id}
- get/exceptions/OpenPreDecisions
- post/exceptions/PreAuthorizeACHDecision
- post/exceptions/PreAuthorizeCheckDecision
- post/exceptions/TakePreDecisionAction
Decisionfile (Collapsed)
Decisionfile Operations
Dashboard (Collapsed)
Client (Collapsed)
Client Operations
- get/client/ActiveBusinessClientUsers/{clientId}
- post/client/AddNewBusinessClient
- post/client/AddNewBusinessClientByIntegrator
- post/client/AddUpdateUser
- post/client/BusinessClientOptions/{clientId}/{product}
- post/client/BusinessClients/{clientId}
- post/client/BusinessClientUsers/{clientId}
- get/client/DeactivateBusinessClient/{clientId}
- post/client/DefaultDecisionLogs
- post/client/DefaultDecisionLogsBC
- get/client/GetBusinessClientOption/{clientId}
- post/client/GetBusinessClientOptions/{clientId}
- get/client/GetClient
- get/client/GetClientSettings
- get/client/GetReturnReasonConfig/{clientId}/{productId}
- get/client/GetReturnReasons
- get/client/GetReturnReasonsByClient/{clientId}
- post/client/IntegratorClients
- get/client/MyClients
- post/client/NotificationLogs
- post/client/SystemLogs
- post/client/UpdateBusinessClient
- post/client/UpdateClient
- post/client/UpdateReturnReasonConfig/{clientId}/{productId}
Check (Collapsed)
Check Operations
- post/check/AddUpdateIssuedCheck
- post/check/AddUpdatePresentedCheck
- get/check/DeleteIssued/{id}
- get/check/DeletePresented/{id}
- post/check/ExistingIssuedCheck
- post/check/ExistingPresentedCheck
- get/check/GetIssuedCheck/{id}
- get/check/GetPresentedCheck/{id}
- post/check/IssuedChecks
- post/check/PresentedChecks
- get/check/TotalValidations/{id}
- get/check/ViewImage/{id}
Branding (Collapsed)
Billingreport (Collapsed)
Billingreport Operations
- post/BillingReport/AddUpdateReport
- get/BillingReport/DeleteReport/{id}
- get/BillingReport/Download/{id}
- get/BillingReport/GenerateReport/{id}
- get/BillingReport/GetReport/{id}
- post/BillingReport/Logs
- get/BillingReport/RedeliverReport/{id}
- post/BillingReport/Reports
- post/BillingReport/RequestReport
- post/BillingReport/ScheduledReports
Auth (Collapsed)
Auth Operations
Reference (Collapsed)
Reference Operations
- post/reference/ApprovalRuleUsages
- post/reference/DecisionActions
- post/reference/Delimiters
- post/reference/EmailTemplates
- post/reference/NotificationSchedules
- post/reference/NotificationTypes
- post/reference/PreDecisions
- post/reference/Products
- post/reference/ReportFrequencies
- post/reference/TimeZones
Teller (Collapsed)
Teller Operations

