Jump to Content
Modulr
HomeGuidesRecipesAPI ReferenceModConnect
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign InModulr
Guides
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign In
HomeGuidesRecipesAPI ReferenceModConnect

Introduction

  • Welcome
  • Contact
  • Modulr Portal User Guides

Sandbox & Customer Portal Access

  • Modulr Access Types
  • Getting Sandbox Access
  • API Base URLs and Authentication Methods

Using the API

  • Getting Started
    • Security
    • Authentication
    • General implementation notes
    • Limits and Errors
    • Versioning
    • Error handling and duplicate prevention
  • Customers
    • Industry Codes for Modulr KYC
  • Accounts
  • Payments
    • Inbound Payments
    • Outbound Payments
    • Bulk payments
    • Batch Payments
    • Payment Approvals
    • Payment Types
    • Payment Statuses
    • Returned Payments
    • Payment rules
    • Future Dated
    • Waiting for funds
    • UK Payment Purpose & Category Codes
  • Confirmation of Payee (CoP)
    • Sending Name Check Requests
    • Responding to Name Check Requests
  • Payment Initiation Service
    • Getting Started with the Payment Initiation Service
    • Single Immediate Payments
    • Fixed Recurring Payments (Standing Orders)
    • Supported ASPSP (Banks)
    • Open Banking V4 API transition
  • Variable Recurring Payments
    • VRP overview
    • Getting started with VRP
    • VRP consent
    • Initiate a VRP payment
  • Direct Debits (Outbound & Collections)
    • Direct Debit Outbound
      • Receiving Mandates
      • Receiving DD Collections
    • Direct Debit Collections (UK - GBP)
      • Getting started
      • Setting up Mandates
      • Starting Collections
      • Payer Name Verification (PNV)
  • Bacs Day 2 - Early funding
  • International Payments
    • Inbound Payments via SWIFT
    • Outbound Payments via SWIFT
      • Allowed destinations for supported currencies
  • European Payments
    • FAQs
  • Cards
    • Getting started with Virtual Cards
    • Getting started with Physical Cards
    • Replacing a card
    • Card Lifecycle
    • Transaction Lifecycle
    • Card Notifications
    • API Integration overview
    • PCI - Retrieve secure card details
    • PIN Management
    • Card Activities Simulation
    • Custom Reference Fields
    • Card Reports
    • Card Report Notifications
    • Card Controls
    • Transaction decline reasons
    • Tokenisation - Overview
    • Provisioning Journey
    • Token Management
    • General Tokenisation Setup
    • Channel Managers
      • Channel Managers - Overview
      • Channel Manager - Cards
      • Channel Manager - Activities
      • Channel Manager - Reports
  • Notifications (Webhooks & Emails)
    • Webhook - Customer Verification Status
    • Webhook - Account Status Change
    • Webhook - Inbound Payments
    • Webhook - Outbound Payments
    • Webhook - Payment Approval Status Change
    • Webhook - Payment Compliance Status
    • Webhook - Direct Debit Collections, Mandate Status
    • Webhook - Direct Debit, Upcoming Collection Credit
    • Webhook - Direct Debit, DD Collection Status
    • Webhook - Direct Debit, Incoming Collection
    • Webhook - Direct Debit, Unpaid Collection
    • Webhook - Direct Debit, Return Funds
  • Users
    • Access Groups
  • Third Party Providers

Using the Modulr Portal

  • The Modulr Portal
  • Signing up to use Modulr
    • Information we ask for at signup
  • Portal Setup and Twilio Authy (2FA)
    • How do I set up my access and Twilio Authy?
    • Email Verification - Authy Alternative
    • When do I need to use Authy?
    • What do I do when Authy is required?
    • How do I change my password?
    • Single Sign On (SSO)
    • Authy Desktop App migration
  • Modulr Portal setup types
  • Users
    • How do I create a user?
    • What do the different user roles mean?
    • How do I edit or delete a user?
    • How do I view my user details if I’m not an Admin?
  • Access Groups setup
    • How do I create an Access Group?
    • How do I add Accounts to an Access Group?
    • How do I add Beneficiaries to an Access Group?
    • How do I add Users to an Access Group?
    • How do I manage an Access Group's contents?
    • How do I delete an Access Group?
  • Delegates
    • Delegate (Accountant/Bureau) Users - Creating Customers
    • For Customers – Delegate linking
    • For Delegates – finding your Delegate reference info
    • Delegate Dashboard
  • Accounts
    • How do I see all the accounts I can view?
    • How do I view an account?
    • Where do I find the sort code and account number?
    • How do I view and search transactions?
    • How do I get an account’s statement?
    • How do I get a Proof of Account document?
    • How do I change the account’s alias (nickname)?
    • Can I add more accounts?
  • Adding funds
    • How do I add funds to an account?
    • Adding funds from your bank
  • Beneficiaries
    • How do I create a Beneficiary?
    • How do I view my Beneficiaries?
    • How do I approve a Beneficiary?
    • How do I delete a Beneficiary?
  • Making Payments in the Modulr Portal
    • How do I pay to a saved Beneficiary?
    • How do I transfer to one of my other Modulr accounts?
    • How do I pay to a new Beneficiary?
  • Managing Payments
    • How do I view and search Pending Payments?
    • How do I view Pending Payment batches?
    • Can I cancel a payment that is pending?
    • What do the payment statuses mean?
  • Payment file upload
    • Formatting a payment file
    • Example payment files
    • How do I upload a payment file?
  • Payment rules setup
    • How do I set up a Split Rule?
    • How do I set up a Conditional Split Rule?
    • How do I set up a Sweep Rule?
    • How do I set up a Funding Rule?
    • How do I edit a Rule's settings?
    • How do I delete a Rule?
  • Managing Approvals
    • How do I approve or reject a payment or beneficiary?
    • How do I approve or reject a payment batch?
    • Multi-user approvals
    • How do I know when Approvals are waiting?
  • Modulr Mobile Approvals App
  • Reports – Transactions and User Activity
    • Modulr Portal Reports
    • Modulr Portal: How do I download reports?
  • Notifications
    • Available notifications
    • How do I set up notifications?
  • Sage Salary and Supplier Payments
    • Signing up to use Sage with Modulr
    • Using Sage Salary and Supplier Payments
  • Xero and Modulr
    • Setting up Xero and Modulr
    • Xero payment conditions
    • Making a payment with Xero
    • Making a batch payment with Xero
    • Xero - Activate Pay Runs
    • Xero payrun sync
    • Xero notifications
    • Xero - key information for users
  • Cards – Direct Users
    • Cards
      • Creating Virtual Cards
      • Managing Virtual Cards
      • Authorisation Windows
    • Reports (Virtual Cards)
      • Card Activity Report
      • Funding Account Activity Report
      • Scheduled Card Authorisations Report
    • Settings - Custom Fields
  • Cards – Partner Users
    • How do I find a Card?
    • How do I view the cards on an account?
    • How do I view a Card's details?
    • How do I create a Virtual Card?
    • How do I create a Physical Card?
    • How do I view requested Physical Cards?
    • How do I view a Card's transactions?
    • How do I view or update a cardholder's details?
    • What's the api management token?
  • Creating Customers – Partners
    • In-house KYC Partners
    • Outsourced KYC Partners

Direct Debits (Outbound & Collections)

Learn about setting up Payments and Collections via Direct Debits

Suggest Edits
  • Access Direct Debit Outbound Guides here
  • Access Direct Debit Collections Guides here

Updated 11 months ago


What’s Next
  • Direct Debit Outbound
  • Direct Debit Collections (UK - GBP)

The Modulr Portal User Guides have a new home — Find them here. Developer and API guides will continue to live here on this site.