For AI agents: visit https://modulr.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
ModulrModulr
HomeGuidesRecipesAPI ReferenceProduct Updates
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign InModulr
API Reference
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign In
HomeGuidesRecipesAPI ReferenceProduct Updates

Modulr API

  • Accounts
    • Create account by customerpost
    • Get an accountget
    • Get accounts by customerget
    • Get accounts using filterget
    • Edit an accountput
    • Set the secured funding limit for an accountput
    • Block a specific accountpost
    • Unblock a specific accountpost
    • Close an accountpost
  • Cards
    • Card Simulator
      • Create a card authorisationpost
      • Settle the full or partial card authorisationpost
      • Reverse the card authorisationpost
      • Perform an account status inquirypost
      • Create a settlement without prior authorisationpost
      • Create a card refundpost
      • Simulate an original creditpost
      • Reverse an original creditpost
      • Create a standalone chargebackpost
      • Chargeback an existing settlementpost
      • Create an offline transactionpost
      • Reverse a chargebackpost
      • Simulate a card expirypost
      • Reverse a credit authorisationpost
      • Simulate a credit authorisationpost
      • Resettlement of a chargebackpost
      • Unbind a device from a card tokenpost
    • Async
      • Get tasksget
      • Get a card taskget
      • Get physical card create tasks by accountget
    • Activities, Reports & Reports Notifications
      • Retrieve card report type notification configuration for partnerget
      • Update report type notification configuration for partnerpost
      • Delete card report notification configuration for partner and report typedel
      • Toggle card report notification for partner and report typepost
      • Retrieve card report type notification configuration for customerget
      • Update report type notification configuration for customerpost
      • Delete card report notification configuration for customer and report typedel
      • Toggled notifications for customer and card report typepost
      • Retrieve card reportsget
      • Download a specific card reportget
      • View activities for specific cards or over a date rangeget
    • Custom Fields
      • Bulk create partner custom field keyspost
      • Bulk create customer custom field keyspost
      • Update a card's custom fieldspost
      • View existing partner card custom field keysget
      • View existing customer card custom field keysget
      • Delete partner custom field keydel
      • Delete customer custom field keydel
      • Delete card custom fielddel
    • Share secure card details
      • Retrieve a single share secure card details recordget
      • Update share secure detailsput
      • Retrieve share secure card detailsget
      • Share secure card details via EMAIL or RETURN methodspost
      • Delete all share secure card details for a carddel
      • Retrieve share details activity of tokenget
      • Delete share secure card detailsdel
    • Channel Manager Card
      • Channel Manager Update cardpost
      • Channel Manager Update cardpatch
      • Channel Manager Update Card Custom Fieldspost
      • Channel Manager Replace card post
      • Channel Manager Card enquirypost
      • Channel Manager Create card post
      • Retrieve channel manager's cardsget
      • Retrieve channel manager's card activitiesget
      • Retrieve channel manager's card reportsget
      • Channel Manager download a specific card reportget
    • Channel Manager Webhook Notifications
      • Retrieve Webhook notification configurationsget
      • Create a Webhook notification configurationpost
      • Retrieve Webhook notification configurationget
      • Update a specific Webhook notification configuration for a Channel Managerpatch
      • Retrieve Webhook notification configurationsget
    • Create a new physical cardpost
    • Activate a physical cardpost
    • Create a new virtual cardpost
    • View the details of an existing cardget
    • View the details of existing cards by accountget
    • View the details of existing cardsget
    • Update a cardpost
    • Update cardpatch
    • Update card authenticationput
    • Restricted
      • [Restricted] Unsuspend a cardpost
      • [Restricted] Suspend an existing cardpost
      • [Restricted] Expire an existing authorisationpost
    • Block an existing cardpost
    • Unblock an existing cardpost
    • Cancel an existing cardpost
    • Replace a cardpost
    • Create secure card details tokenpost
    • Retrieve secure card details (PAN + CVV + PIN)get
    • Card enquirypost
    • Retrieve PINget
    • Reset card PINpost
    • Reset card PINpost
    • Unblock PINpost
    • Get in-app provisioning data for Apple Paypost
    • Get card tokensget
    • Get card token OTP detailsget
    • Suspend card tokenpost
    • Unsuspend card tokenpost
    • Deactivate card tokenpost
    • Download a specific card reportget
  • Beneficiaries
    • Create a new beneficiary for a specified customerpost
    • Retrieve beneficiariesget
    • Retrieve locked beneficiary entitiesget
    • Delete beneficiaries for a specified customerdel
  • Confirmation of Payee
    • Create an account name checkpost
    • Create an account name check for Direct Debit Payerpost
    • Get SRD Accountsget
  • Customers
    • Create a new customerpost
    • Retrieve customers using filtersget
    • Retrieve a specific customer using a unique customer referenceget
    • Edit a specific customer using a unique customer referenceput
    • Edit a customerpatch
    • Create or update a customer’s tax identifiersput
    • Create or update customer identification informationput
    • Create or update the list of countries where an associate is considered tax-residentput
    • Create or update tax identifiers for an associateput
    • Create or update an associate’s personal detailsput
    • Create or update the department code for an associateput
    • Create or update identification document details for an associateput
    • Get all associates for a customerget
    • Create or Update Tax Residency Information for an Application Associateput
    • Create or Update Personal Details for an Application Associateput
    • Add an individual/associated entity to an Onboarding Applicationpost
    • Create a secure Customer Verification SDK Sessionpost
    • Create a New Onboarding Applicationpost
    • Submit an application for verificationpost
    • Create or Update Know Your Customer Data for a Customer Applicationput
    • Get business addresses for an Onboarding Applicationget
    • Add a business address to an Onboarding Applicationpost
    • Submit a business application for verificationpost
    • Mark application as closed for modificationpost
    • Submit an associate for verificationpost
  • Direct Debits
    • Create a Direct Debit mandate for the given account-id.post
    • Create the collection schedule for the given mandate-id.post
    • Represent collection for given collection idpost
    • Get Mandates based on search criteria.get
    • Get all collectionschedules for a mandateget
    • Get all collection activities of an accountget
    • Get Reconciliations based on search criteria.get
    • Cancel Mandate for given mandate-id.post
    • Bulk request of Direct Debit mandates for the given account-id.post
    • Bulk mandate cancellation request for the given account-id.post
    • Cancel a Direct Debit collection schedule for the given collection-id.post
    • Cancel a Direct Debit collection for the given collection-id.post
    • Direct Debit Outbound Mandate Operations
      • Reject Collectionpost
      • Cancel a specific Mandatepost
      • Retrieve all Mandates for an accountget
    • Get Indemnity Claims based on search criteriaget
    • Get an Indemnity Claim for a given idget
  • Payments
    • Create a paymentpost
    • Make a batch paymentpost
    • Retrieve paymentsget
    • Get batch payment by IDget
    • Get batch payments by a given set of parametersget
    • Cancel the batch paymentpost
    • Endpoint to mock the credit of an accountpost
  • Rules
    • Create a Rulepost
    • Get all Rules for a specific Accountget
    • Retrieve a Rule by rule type on a specific accountget
    • Edit a specific Ruleput
    • Delete a Ruledel
  • Transactions
    • Get transactions for a specific Accountget
  • Document
    • Uploads and stores documentpost
    • Uploads and stores documents associated with an existing customer recordpost
  • Access Group
    • Create access grouppost
    • Get a list of access groupsget
    • Get access groupget
    • Update access groupput
  • Application Business Controller
    • Get business entity for an Onboarding Applicationget
    • Add a business entity to an Onboarding Applicationpost
  • File Upload
    • Upload payment file and store valid paymentspost
    • Create payments from an uploaded filepost
    • Get an upload file latest statusget
    • Create payments from one or more uploaded filespost
    • Get paginated summaries of child file uploadsget
  • Notification
    • Set up a Notification for a Partnerpost
    • Get all Notifications linked directly to a Partnerget
    • Retrieve a specific notification by unique reference for a specific partnerget
    • Update a specific notification by unique reference for a specific partnerput
    • Set up a Notification for a Customerpost
    • Get all Notifications for a Customerget
    • Retrieve a specific notification by unique reference for a specific customerget
    • Update a specific notification by unique reference for a specific customerput
    • Check if a particular webhook has failedget
  • Cards Bulk Operations
    • List active bulk card requestsget
    • Submit bulk cards operationspost
    • Upload CSV file with bulk card operationspost
    • Get bulk cards by idget
    • Mark bulk request as deleteddel
  • Integration Notification
    • Retrieve all Webhook Notification Subscriptions for a Customer.get
    • Set up a new Webhook Notification Subscription for a Customer.post
    • Retrieve a specific Webhook Notification Subscription for a Customer using the Notification ID.get
    • Update a specific Webhook Notification Subscription for a Customer.put
    • Delete a Webhook Notification Subscription for a Customer using the Notification ID.del
    • Retrieve failed Webhook Notifications for a Webhook using the Notification ID.get
  • Variable Recurring Payments
    • Initiate a Variable Recurring Payment.post
    • Create a VRP consentpost
    • Confirm the availability of funds in an account.post
    • Get Variable Recurring Paymentget
    • Get VRP consent.get
    • Revoke a VRP consent.del
  • Payment Initiations
    • Initiate standing order from ASPSPpost
    • Initiate payment from ASPSPpost
    • Get standing order initiation request detailsget
    • Get payment initiation request detailsget
    • Get supported ASPSPsget
  • Verification of Payee
    • Create Verification of Payee (VOP) requestpost

Direct Debit Outbound Mandate Operations

Learn more about implementing these endpoints with our below guides

  • Payment Collection Use Cases
  • Set Up Recurring Collections
  • Failed Payments Recovery

Updated about 1 month ago


Cancel a Direct Debit collection for the given collection-id.
Reject Collection
Did this page help you?

Updated about 1 month ago


Cancel a Direct Debit collection for the given collection-id.
Reject Collection
Did this page help you?

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