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)
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/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/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}
- get/rule/PayeeNames/{clientId}
- post/rule/Payees
- post/rule/RuleExists
- post/rule/UpdateCompany
- post/rule/UpdatePayee
Holiday (Collapsed)
File (Collapsed)
File Operations
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)
Client (Collapsed)
Client Operations
- post/client/AddNewBusinessClient
- post/client/AddNewBusinessClientByIntegrator
- post/client/AddUpdateUser
- post/client/BusinessClients/{clientId}
- post/client/BusinessClientUsers/{clientId}
- get/client/DeactivateBusinessClient/{clientId}
- post/client/DefaultDecisionLogs
- post/client/DefaultDecisionLogsBC
- get/client/GetClient
- get/client/GetClientSettings
- get/client/GetClientSettingsByShortName/{value}
- get/client/GetLandingPage/{id}
- 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)
Auth (Collapsed)
Auth Operations
Reference (Collapsed)
Teller (Collapsed)
Teller Operations
