# Modulr Documentation
> Modulr help. Modulr help guides. Modulr customer service. Modulr customer support. Modulr customer portal. Customer portal. Modulr how to. Modulr API : Integrate with Modulr quickly and easily. A developer space with all the information and guides to get going quickly. Full API catalogue
## Guides
- [Welcome](https://modulr.readme.io/docs/intro.md): This is the place to learn about Modulr's API, View API Documentation and learn about the Modulr Portal
- [Contact](https://modulr.readme.io/docs/help-support.md)
- [Modulr Portal User Guides](https://modulr.readme.io/docs/using-the-customer-portal-sandbox-and-production.md): Access our Modulr Portal Guides to learn how to use the Sandbox and Production Portal.
- [Modulr Access Types](https://modulr.readme.io/docs/types-of-businesses-1.md)
- [Getting Sandbox Access](https://modulr.readme.io/docs/gaining-use-of-the-api.md)
- [API Base URLs and Authentication Methods](https://modulr.readme.io/docs/api-base-urls.md): Learn about the different Base URL options for use in the Modulr Sandbox
- [Build With AI (MCP)](https://modulr.readme.io/docs/build-with-ai-mcp.md)
- [Getting Started](https://modulr.readme.io/docs/getting-started.md)
- [Security](https://modulr.readme.io/docs/security.md)
- [Authentication](https://modulr.readme.io/docs/authentication.md)
- [General implementation notes](https://modulr.readme.io/docs/implementation-notes.md)
- [Limits and Errors](https://modulr.readme.io/docs/limits-and-errors.md)
- [Versioning](https://modulr.readme.io/docs/versioning.md)
- [Error handling and duplicate prevention](https://modulr.readme.io/docs/error-handling.md)
- [Fundamentals](https://modulr.readme.io/docs/apis-to-aid-with-reconciliation.md): Improving your integration to Modulr
- [Payments and Transactions](https://modulr.readme.io/docs/payments-and-transactions.md): Payments are always created first
- [Webhooks](https://modulr.readme.io/docs/webhooks.md): Making Best Use of the Modulr webhooks
- [Reversals and Reconciliation](https://modulr.readme.io/docs/reversals.md): When payments come back
- [Combining Webhooks and APIs](https://modulr.readme.io/docs/reconciliation.md): Making best use of the Modulr APIs and webhooks combined
- [Notifications (Webhooks & Emails)](https://modulr.readme.io/docs/notifications-1.md)
- [Webhook - Application Status Change](https://modulr.readme.io/docs/webhook-application-status-change.md)
- [Webhook - Customer Created](https://modulr.readme.io/docs/webhook-customer-created.md)
- [Webhook - Customer Status](https://modulr.readme.io/docs/customer-status.md): For Partners, to be notified that a Customer is fully Approved as part of the KYC/KYB process.
- [Webhook - Customer Verification Status](https://modulr.readme.io/docs/custvstat-webhook.md): For Partners, to be notified of a Customer's initial Verfication Status updating, as they progress through the KYC/KYB process.
- [Webhook - Account Status Change](https://modulr.readme.io/docs/webhook-account-status-change.md)
- [Webhook - Inbound Payments](https://modulr.readme.io/docs/payin-webhook.md)
- [Webhook - Outbound Payments](https://modulr.readme.io/docs/payout-webhook.md)
- [Webhook - Payment Approval Status Change](https://modulr.readme.io/docs/payment-approval-rejection-webhook.md): A webhook for when an Individual Payment is Approved/Rejected by a user. Must be subscribed to at a Customer Level.
- [Webhook - Batch Payment Approval Status Change](https://modulr.readme.io/docs/webhook-batch-payment-approval-status-change.md): A webhook for when a Batch Payment is Approved/Rejected by a user. Must be subscribed to at a Customer Level.
- [Webhook - Payment Compliance Status](https://modulr.readme.io/docs/paymentcompliancestatus-webhook.md)
- [Webhook - Direct Debit Mandate Status](https://modulr.readme.io/docs/ddmandate-webhook.md): Applicable to the Direct Debit Outbound and Direct Debit Collections services
- [Webhook - Direct Debit, Upcoming Collection Credit](https://modulr.readme.io/docs/upcomingddcollectioncredit-webhook.md): Applicable to Direct Debit Collections service
- [Webhook - Direct Debit, DD Collection Status](https://modulr.readme.io/docs/webhook-direct-debit-ddcollectionstatus.md)
- [Webhook - Direct Debit, Incoming Collection](https://modulr.readme.io/docs/webhook-direct-debit-incoming-collection.md): Applicable only for Direct Debit Outbound service.
- [Webhook - Direct Debit, Unpaid Collection](https://modulr.readme.io/docs/webhook-direct-debit-unpaid-collection.md): Applicable only for Direct Debit Outbound service.
- [Webhook - Direct Debit, Return Funds](https://modulr.readme.io/docs/webhook-direct-debit-return-funds.md)
- [Webhook - Direct Debit Collections Indemnity Claim (DDIC) ](https://modulr.readme.io/docs/webhook-direct-debit-collections-ddic.md)
- [Customers](https://modulr.readme.io/docs/customer.md)
- [Industry Codes for Modulr KYC](https://modulr.readme.io/docs/industry-codes-for-modulr-kyc.md)
- [Customer Verification: Overview](https://modulr.readme.io/docs/customer-verification-overview.md)
- [Customer Verification: Integration Guide](https://modulr.readme.io/docs/customer-verification-integration-guide.md)
- [Customer Verification: Application Statuses](https://modulr.readme.io/docs/customer-verification-application-statuses.md)
- [Accounts](https://modulr.readme.io/docs/account.md)
- [Payments](https://modulr.readme.io/docs/payments-2.md)
- [Inbound Payments](https://modulr.readme.io/docs/inbound-payments.md)
- [Outbound Payments](https://modulr.readme.io/docs/outbound-payments.md)
- [Bulk payments](https://modulr.readme.io/docs/bulk-payments.md): Creating multiple single payments with a single file upload
- [Batch Payments](https://modulr.readme.io/docs/batch-payments-1.md)
- [Payment Approvals](https://modulr.readme.io/docs/approvals.md)
- [Payment Types](https://modulr.readme.io/docs/payment-types.md)
- [Payment Statuses](https://modulr.readme.io/docs/payment-statuses.md)
- [Returned Payments](https://modulr.readme.io/docs/payment-return-reasons.md)
- [Payment rules](https://modulr.readme.io/docs/rules-1.md)
- [Future Dated](https://modulr.readme.io/docs/future-dated-payments.md)
- [Waiting for funds](https://modulr.readme.io/docs/waiting-for-funds.md)
- [UK Payment Purpose & Category Codes](https://modulr.readme.io/docs/uk-payment-purpose-category-codes.md): From UK recommended Purpose Code list
- [European Payments](https://modulr.readme.io/docs/european-payments.md)
- [International Payments](https://modulr.readme.io/docs/international-payments.md)
- [Inbound Payments via SWIFT](https://modulr.readme.io/docs/inbound-payments-via-swift.md)
- [Outbound Payments via SWIFT](https://modulr.readme.io/docs/outbound-payments-via-swift.md)
- [Allowed destinations for supported currencies](https://modulr.readme.io/docs/allowed-destinations-for-modulr-supported-currencies.md): Where international payments from your Modulr account can be sent
- [Direct Debits (Outbound & Collections)](https://modulr.readme.io/docs/direct-debits-outbound-collections.md): Learn about setting up Payments and Collections via Direct Debits
- [Direct Debit Outbound](https://modulr.readme.io/docs/direct-debit-outbound-1.md)
- [Receiving Mandates](https://modulr.readme.io/docs/receiving-mandates.md)
- [Receiving DD Collections](https://modulr.readme.io/docs/receiving-dd-collections.md)
- [Direct Debit Collections (UK - GBP)](https://modulr.readme.io/docs/direct-debit-collections-1.md)
- [Getting started](https://modulr.readme.io/docs/what-is-dd-collections.md): With the Direct Debit Collection API
- [Setting up Mandates](https://modulr.readme.io/docs/setting-up-mandates.md)
- [Starting Collections](https://modulr.readme.io/docs/starting-collections.md)
- [Payer Name Verification (PNV)](https://modulr.readme.io/docs/payer-name-verification-pnv.md): Confirming a link between the payer and the bank account details provided when creating DDIs (Mandates)
- [Managing Direct Debit Indemnity Claims (DDIC)](https://modulr.readme.io/docs/managing-direct-debit-indemnity-claims-ddic.md)
- [Payment Initiation Service](https://modulr.readme.io/docs/pisp.md): Modulr's DirectPay product
- [Getting Started with the Payment Initiation Service](https://modulr.readme.io/docs/getting-started-with-pisp.md)
- [Single Immediate Payments](https://modulr.readme.io/docs/single-immediate-payments-overview.md)
- [Fixed Recurring Payments (Standing Orders)](https://modulr.readme.io/docs/fixed-recurring-payments-standing-order-overview.md)
- [Supported ASPSP (Banks)](https://modulr.readme.io/docs/supported-banks-and-aspsps.md)
- [Open Banking V4 API transition](https://modulr.readme.io/docs/open-banking-v4-api-transition.md): Information on new fields & ASPSP transition dates
- [Bacs Day 2 - Early funding](https://modulr.readme.io/docs/bacs-day-2-early-funding.md)
- [Cards](https://modulr.readme.io/docs/cards-1.md)
- [Getting started with Virtual Cards](https://modulr.readme.io/docs/getting-started-with-virtual-cards.md)
- [Getting started with Physical Cards](https://modulr.readme.io/docs/physical-cards-overview.md)
- [Replacing a card](https://modulr.readme.io/docs/replacing-a-card-copy.md)
- [Card Lifecycle](https://modulr.readme.io/docs/card-lifecycle.md)
- [Transaction Lifecycle](https://modulr.readme.io/docs/card-transaction-lifecycle.md)
- [Card Notifications](https://modulr.readme.io/docs/card-notifications.md)
- [API Integration overview](https://modulr.readme.io/docs/api-integration-overview.md)
- [PCI - Retrieve secure card details](https://modulr.readme.io/docs/retrieve-secure-card-details.md)
- [Sharing Card Details Securely](https://modulr.readme.io/docs/sharing-card-details-securely.md)
- [PIN Management](https://modulr.readme.io/docs/pin-management.md)
- [Card Activities Simulation](https://modulr.readme.io/docs/example-card-activities-api-response.md)
- [Custom Reference Fields](https://modulr.readme.io/docs/custom-reference-fields.md): How to set up and manage Custom Reference Fields
- [Card Reports](https://modulr.readme.io/docs/card-reports.md)
- [Card Report Notifications](https://modulr.readme.io/docs/card-report-notifications.md)
- [Card Controls](https://modulr.readme.io/docs/card-controls.md)
- [Transaction decline reasons](https://modulr.readme.io/docs/decline-reasons.md)
- [Tokenisation - Overview](https://modulr.readme.io/docs/mobile-wallets.md)
- [Provisioning Journey](https://modulr.readme.io/docs/provisioning-journey-1.md)
- [Token Management](https://modulr.readme.io/docs/token-management.md)
- [General Tokenisation Setup](https://modulr.readme.io/docs/setup.md)
- [Channel Managers](https://modulr.readme.io/docs/channel-managers.md)
- [Channel Managers - Overview](https://modulr.readme.io/docs/channel-managers-overview.md)
- [Channel Manager - Cards](https://modulr.readme.io/docs/channel-manager-cards.md)
- [Channel Manager - Activities](https://modulr.readme.io/docs/channel-manager-activities.md)
- [Channel Manager - Reports](https://modulr.readme.io/docs/channel-manager-reports.md)
- [Channel Manager - Notifications](https://modulr.readme.io/docs/channel-manager-notifications.md)
- [Channel Manager - Setting Up A Webhook ](https://modulr.readme.io/docs/channel-manager-setting-up-a-webhook.md)
- [Bulk Card Operations](https://modulr.readme.io/docs/bulk-card-operations.md)
- [Variable Recurring Payments](https://modulr.readme.io/docs/variable-recurring-payments.md)
- [VRP overview](https://modulr.readme.io/docs/vrp-overview.md)
- [Getting started with VRP](https://modulr.readme.io/docs/getting-started-with-vrp.md)
- [VRP consent](https://modulr.readme.io/docs/create-a-vrp-consent.md): Creating a consent and revoking a consent
- [Initiate a VRP payment](https://modulr.readme.io/docs/initiate-a-vrp-payment-using-a-consent.md): Initiate a sweeping VRP payment using the authorised consent
- [Commercial Variable Recurring Payments](https://modulr.readme.io/docs/commercial-variable-recurring-payments.md)
- [Commercial VRP Overview](https://modulr.readme.io/docs/commercial-vrp-overview.md)
- [Getting started with cVRP](https://modulr.readme.io/docs/getting-started-with-cvrp.md)
- [Creating a cVRP Consent](https://modulr.readme.io/docs/creating-a-cvrp-consent.md)
- [Creating a cVRP Payment](https://modulr.readme.io/docs/creating-a-cvrp-payment.md)
- [Confirmation of Payee (CoP)](https://modulr.readme.io/docs/confirmation-of-payee.md)
- [Sending Name Check Requests](https://modulr.readme.io/docs/sending-name-check-requests.md)
- [Responding to Name Check Requests](https://modulr.readme.io/docs/responding-to-name-check-requests.md)
- [EU Verification of Payee (VoP)](https://modulr.readme.io/docs/eu-verification-of-payee-vop.md): Information about the VoP service being launched by EU PSPs in October 2025
- [Sending verification of payee checks](https://modulr.readme.io/docs/sending-vop-check-requests.md)
- [Responding to verification of payee check requests](https://modulr.readme.io/docs/responding-to-vop-check-requests.md)
- [Collecting Payments with Modulr — Use-Case Guides](https://modulr.readme.io/docs/collecting-payments-with-modulr-use-case-guides.md)
- [Set Up Recurring Collections](https://modulr.readme.io/docs/set-up-recurring-collections.md): What you're building: A recurring payment collection flow — collecting fixed or variable amounts from your customers on a regular schedule. This guide focuses on **Direct Debit** as the primary collection method, and also covers when VRP or PIS standing orders may be the better choice.
- [Failed Payment Recovery — Direct Debit → Pay by Bank](https://modulr.readme.io/docs/failed-payment-recovery-direct-debit-pay-by-bank.md)
- [Third Party Providers](https://modulr.readme.io/docs/third-party-providers-access.md): Information regarding PSD2
- [Platform Reporting and Reconciliation](https://modulr.readme.io/docs/reports-and-reconciliation.md)
- [Delegates](https://modulr.readme.io/docs/delegate-access-1.md)
## API Reference
- [Create account by customer](https://modulr.readme.io/reference/createaccount.md): Creates an account for a particular customer using the customer’s ID as a reference
- [Get an account](https://modulr.readme.io/reference/getaccount.md): Retrieve details of a particular account using its ID as a reference
- [Get accounts by customer](https://modulr.readme.io/reference/getaccountsbycustomer.md): Get details of accounts belonging to a particular customer using the customer’s ID as a reference
- [Get accounts using filter](https://modulr.readme.io/reference/getaccounts.md): Gives the ability to find accounts and get their details using filters
- [Edit an account](https://modulr.readme.io/reference/editaccount.md): Edit details of a particular account using its ID as a reference Currently editable fields: 1. for accounts of all customer types, externalReference can be edited 2. for accounts of PCM_INDIVIDUAL & PCM_BUSINESS customer types, name can additionally be edited
- [Set the secured funding limit for an account](https://modulr.readme.io/reference/updatesecuredfundinglimit.md)
- [Block a specific account](https://modulr.readme.io/reference/blockaccount.md): Using a unique reference (account ID) you can block an account
- [Unblock a specific account](https://modulr.readme.io/reference/unblockaccount.md): Using a unique reference (account ID) you can unblock an account
- [Close an account](https://modulr.readme.io/reference/closeaccount.md): Accounts with a zero balance can be closed. The account must have a status of ACTIVE or CLIENT_BLOCKED.
- [Create a card authorisation](https://modulr.readme.io/reference/createauthorisation.md): Create an authorisation for a card
- [Settle the full or partial card authorisation](https://modulr.readme.io/reference/settleauthorisation.md): Settle the full card authorisation or supply an optional settlementAmount for partial settlement.
- [Reverse the card authorisation](https://modulr.readme.io/reference/reverseauthorisation.md): Simulate a reversal of an authorization for a card
- [Perform an account status inquiry](https://modulr.readme.io/reference/performaccountstatusinquiry.md): Check whether a card is eligible for transactions without reserving funds
- [Create a settlement without prior authorisation](https://modulr.readme.io/reference/createsettlement.md): Submit a settlement directly to the reconciliation pipeline without a prior authorisation
- [Create a card refund](https://modulr.readme.io/reference/refund.md): Simulate a standalone refund (credit) for a card, producing a REFUND activity
- [Simulate an original credit](https://modulr.readme.io/reference/createoriginalcredit.md): Submit card activity of type original credit
- [Reverse an original credit](https://modulr.readme.io/reference/reverseoriginalcredit.md): Reverse a previously applied original credit, producing an ORIGINAL_CREDIT_REVERSAL activity
- [Create a standalone chargeback](https://modulr.readme.io/reference/createchargeback.md): Simulate a standalone chargeback for a card.
- [Chargeback an existing settlement](https://modulr.readme.io/reference/createchargebackforsettlement.md): Simulate a chargeback of an existing settlement activity.
- [Create an offline transaction](https://modulr.readme.io/reference/createofflinetransaction.md): Simulate an offline transaction for a card
- [Reverse a chargeback](https://modulr.readme.io/reference/createchargebackreversal.md): Simulate a chargeback reversal for an existing CHARGEBACK activity, producing a CHARGEBACK_REVERSAL activity.
- [Simulate a card expiry](https://modulr.readme.io/reference/expirecard.md): Simulate the GPS CARD_EXPIRY message, transitioning the card status to EXPIRED in card-service
- [Reverse a credit authorisation](https://modulr.readme.io/reference/reversecreditauthorisation.md): Reverse a pending credit authorisation, producing a CREDIT_AUTH_REV activity
- [Simulate a credit authorisation](https://modulr.readme.io/reference/createcreditauthorisation.md): Submit card activity of type credit authorisation
- [Resettlement of a chargeback](https://modulr.readme.io/reference/createresettlement.md): Simulate a resettlement (second presentment) for an existing CHARGEBACK activity, producing a RESETTLEMENT activity.
- [Unbind a device from a card token](https://modulr.readme.io/reference/unbinddevice.md): Simulate the removal of a device binding from a card token, marking the device as DELETED within the token record in card-service
- [Get tasks](https://modulr.readme.io/reference/getasynctasks.md): View the details of card tasks. Ordered by createdDate, with the newest entries appearing first
- [Get a card task](https://modulr.readme.io/reference/getasynctask.md): Retrieve the card task. If the task is complete, the resource URL will be provided to allow client to fetch the completed resource.
- [Get physical card create tasks by account](https://modulr.readme.io/reference/getcreatephysicalcardasynctasksbyaccount.md): View the details of create physical card tasks by account. Ordered by createdDate, with the newest entries appearing first
- [Retrieve card report type notification configuration for partner](https://modulr.readme.io/reference/getnotificationconfigurationsforagivenpartnerandreporttype.md)
- [Update report type notification configuration for partner](https://modulr.readme.io/reference/updatenotificationconfigurationsforagivenpartnerandreporttype.md)
- [Delete card report notification configuration for partner and report type](https://modulr.readme.io/reference/deleteallnotificationconfigurationsforagivenpartnerandreporttype.md)
- [Toggle card report notification for partner and report type](https://modulr.readme.io/reference/togglenotificationsforagivenpartnerandreporttype.md)
- [Retrieve card report type notification configuration for customer](https://modulr.readme.io/reference/getnotificationconfigurationsforagivencustomerandreporttype.md)
- [Update report type notification configuration for customer](https://modulr.readme.io/reference/updatenotificationconfigurationsforagivencustomerandreporttype.md)
- [Delete card report notification configuration for customer and report type](https://modulr.readme.io/reference/deleteallnotificationconfigurationsforagivencustomerandreporttype.md)
- [Toggled notifications for customer and card report type](https://modulr.readme.io/reference/togglenotificationsforagivencustomerandreporttype.md)
- [Retrieve card reports](https://modulr.readme.io/reference/searchreports.md): Retrieve card reports
- [Download a specific card report](https://modulr.readme.io/reference/retrievereport.md): Download a specific card report
- [View activities for specific cards or over a date range](https://modulr.readme.io/reference/getcardactivities.md): View activities for a specified list of cards and a given time frame. View activities for all cards belonging to a specified list of accounts and a given time frame. View all activities for a single card when a single card ID is specified, time frame is optional.
- [Bulk create partner custom field keys](https://modulr.readme.io/reference/bulkcreatepartnercustomfieldkeys.md): Bulk create partner custom field keys
- [Bulk create customer custom field keys](https://modulr.readme.io/reference/bulkcreatecustomercustomfieldkeys.md): Bulk create customer custom field keys
- [Update a card's custom fields](https://modulr.readme.io/reference/updatecardcustomfields.md): Replace the values of a card's custom fields if they exist or create new custom fields with the given values if they do not exist
- [View existing partner card custom field keys](https://modulr.readme.io/reference/getpartnercustomfieldkeys.md)
- [View existing customer card custom field keys](https://modulr.readme.io/reference/getcustomercustomfieldkeys.md)
- [Delete partner custom field key](https://modulr.readme.io/reference/deletepartnercustomfieldkey.md): Delete partner custom field key
- [Delete customer custom field key](https://modulr.readme.io/reference/deletecustomercustomfieldkey.md): Delete customer custom field key
- [Delete card custom field](https://modulr.readme.io/reference/deletecardcustomfield.md): Delete card custom field
- [Retrieve a single share secure card details record](https://modulr.readme.io/reference/getsharesecurecarddetailsbyid.md): This endpoint retrieves a specific share secure card details record for a given card and share details token id
- [Update share secure details](https://modulr.readme.io/reference/updatesharesecuredetails.md): This endpoints allows updating the share secure card details
- [Retrieve share secure card details](https://modulr.readme.io/reference/getsharesecurecarddetails.md): This endpoint allows the user to retrieve the share secure card details for a specific card
- [Share secure card details via EMAIL or RETURN methods](https://modulr.readme.io/reference/createsharesecuredetails.md): This endpoint allows the user to create a link to share secure card details for a specific card
- [Delete all share secure card details for a card](https://modulr.readme.io/reference/deletesharesecuredetailscardlink.md): This endpoint allows the user to delete the link to share secure card details for a specific card
- [Retrieve share details activity of token](https://modulr.readme.io/reference/getsharesecurecarddetailstokenactivity.md): This endpoint allows the user to retrieve the share secure card details activity for a specific share token
- [Delete share secure card details](https://modulr.readme.io/reference/deletesharesecuredetails.md): This endpoint allows the user to delete the share secure card details for a specific Id
- [Channel Manager Update card](https://modulr.readme.io/reference/channelmanagerupdatecard.md): Update a virtual card
- [Channel Manager Update card](https://modulr.readme.io/reference/channelmanagerupdatecard_1.md): Update card - for now, the removal of cancellationDate, authWindowStartDate and authWindowEndDate fields is the only allowed action
- [Channel Manager Update Card Custom Fields](https://modulr.readme.io/reference/channelmanagerupdatecardcustomfields.md): Replace the values of a card's custom fields if they exist or create new custom fields with the given values if they do not exist
- [Channel Manager Replace card ](https://modulr.readme.io/reference/channelmanagerreplacecard.md): Replace a card, with a reason STOLEN, DAMAGED, LOST, RENEW
- [Channel Manager Card enquiry](https://modulr.readme.io/reference/channelmanagercardenquiry.md): Retrieve card details by PAN
- [Channel Manager Create card ](https://modulr.readme.io/reference/channelmanagercreatecard.md): Create a new virtual card
- [Retrieve channel manager's cards](https://modulr.readme.io/reference/channelmanagergetcards.md): Retrieve cards owned by the channel manager
- [Retrieve channel manager's card activities](https://modulr.readme.io/reference/channelmanagergetcardactivities.md): Retrieve card activities owned by the channel manager or over specific Date range.View card activities for a single card when a card ID is specified, time frame is optional.
- [Retrieve channel manager's card reports](https://modulr.readme.io/reference/channelmanagersearchcardreports.md): Retrieve card reports owned by the channel manager
- [Channel Manager download a specific card report](https://modulr.readme.io/reference/channelmanagerretrievereport.md): Download a specific card report
- [Channel Manager Webhook Notifications](https://modulr.readme.io/reference/webhook-notifications.md): Webhooks specifically to work with Channel Manager Integrations
- [Retrieve Webhook notification configurations](https://modulr.readme.io/reference/channelmanagergetwebhooknotifications.md): Retrieve Webhook notification configurations for the authenticated Channel Manager
- [Create a Webhook notification configuration](https://modulr.readme.io/reference/channelmanagercreatewebhooknotification.md): Create a Webhook notification configuration for the authenticated Channel Manager
- [Retrieve Webhook notification configuration](https://modulr.readme.io/reference/channelmanagergetwebhooknotification.md): Retrieve a Webhook notification configuration for the authenticated Channel Manager
- [Update a specific Webhook notification configuration for a Channel Manager](https://modulr.readme.io/reference/channelmanagerupdatewebhooknotification.md): Update a specific Webhook notification configuration for a Channel Manager. Replace operations are the only available
- [Retrieve Webhook notification configurations](https://modulr.readme.io/reference/channelmanagergetwebhooknotifications_1.md): Retrieve Webhook notification configurations for the authenticated Channel Manager
- [Create a new physical card](https://modulr.readme.io/reference/createphysicalcard.md): Asynchronously create a physical card. The response will include a resource to allow the client to check the status of the request.
- [Activate a physical card](https://modulr.readme.io/reference/activatecard.md): Physical cards issued by Modulr will be mailed out to cardholders in an inactive state. A cardholder will need to have their card activated before it can be used. Cards can only be activated whilst they have a status of `CREATED`.
- [Create a new virtual card](https://modulr.readme.io/reference/createcard.md)
- [View the details of an existing card](https://modulr.readme.io/reference/getcard.md)
- [View the details of existing cards by account](https://modulr.readme.io/reference/getcardsbyaccount.md)
- [View the details of existing cards](https://modulr.readme.io/reference/getcards.md)
- [Update a card](https://modulr.readme.io/reference/update.md): Update card and cardholder details
- [Update card](https://modulr.readme.io/reference/updatecard.md): Update card - for now, the removal of cancellationDate, authWindowStartDate and authWindowEndDate fields and the update of frequencyUsage field are the only allowed actions
- [Update card authentication](https://modulr.readme.io/reference/updatecardauthentication.md): Support knowledge based authentication (KBA)
- [[Restricted] Unsuspend a card](https://modulr.readme.io/reference/unsuspendcard.md): Restores a previously suspended card to the status it was in prior to being suspended as applied by the issuer or program manager. Use of this endpoint is `Restricted`, depending on access being granted through contractual setup with Modulr.
- [[Restricted] Suspend an existing card](https://modulr.readme.io/reference/suspendcard.md): Suspends a card to temporarily prevent any new authorisations as applied by the issuer or the program manager (i.e. not cardholder elective). This means that all new authorisations will be immediately declined. Outstanding authorisations are unaffected and settlement, chargebacks, refunds, etc will continue to function as normal. Use of this endpoint is `Restricted`, depending on access being granted through contractual setup with Modulr.
- [[Restricted] Expire an existing authorisation](https://modulr.readme.io/reference/expireauthorisation.md): [Restricted] Expire an existing authorisation. Note: CREDIT_AUTH and CREDIT_AUTH_REV activities cannot be expired via this endpoint.
- [Block an existing card](https://modulr.readme.io/reference/blockcard.md): Blocking a card temporarily disables authorisation processing. This means that all _new_ authorisations will be immediately declined. Outstanding authorisations are unaffected and settlement, chargebacks, refunds, etc will continue to function as normal.
- [Unblock an existing card](https://modulr.readme.io/reference/unblockcard.md): Unblocking a card re-enables normal authorisation processing.
- [Cancel an existing card](https://modulr.readme.io/reference/cancelcard.md): Cancelling a card _**permanently**_ disables authorisation processing & _**destroys**_ the card from the card scheme perspective. This means that all _new_ authorisations will be immediately declined and this cannot be reversed. Outstanding authorisations are unaffected and settlement, chargebacks, refunds, etc will continue to function as normal.
- [Replace a card](https://modulr.readme.io/reference/replacecard.md): Replace a card, with a reason STOLEN, DAMAGED, LOST, RENEW.
- [Create secure card details token](https://modulr.readme.io/reference/generatecardholdertoken.md): Create a token that is used as a parameter to retrieve secure card details (PAN, CVV, and PIN) or to perform PIN alterations. This token is to be retrieved by the partner and pushed to the cardholder device where the call is made. The token will be valid for 60 seconds.
- [Retrieve secure card details (PAN + CVV + PIN)](https://modulr.readme.io/reference/getsecurecarddetails.md): Receives the secure card details token as a parameter. This call is meant to be done from the cardholder device and not directly by the partner
- [Card enquiry](https://modulr.readme.io/reference/cardenquiry.md): Retrieve card details by PAN
- [Retrieve PIN](https://modulr.readme.io/reference/retrievepin.md): Retrieves the PIN for a card, as a reminder for the cardholder
- [Reset card PIN](https://modulr.readme.io/reference/resetpin.md): Reset the card's PIN for a specific card
- [Reset card PIN](https://modulr.readme.io/reference/secureresetpin.md): Reset the PIN for a card using a client access token. This should be done from the card-holder device and not directly by the partner
- [Unblock PIN](https://modulr.readme.io/reference/unblockpin.md): Unblock the card's PIN so that it can be used by the cardholder. CVC2 will also be unblocked, where required.
- [Get in-app provisioning data for Apple Pay](https://modulr.readme.io/reference/getinappprovisioningforapple.md): Retrieves and encrypts the data needed for the client application to provision a card to Apple Pay
- [Get card tokens](https://modulr.readme.io/reference/getcardtokens.md): Retrieves all payment card tokens for the given card
- [Get card token OTP details](https://modulr.readme.io/reference/getotpdetails.md): Retrieves the OTP details given the corresponding card token ID
- [Suspend card token](https://modulr.readme.io/reference/suspendcardtoken.md): Suspends a token to temporarily prevent any new authorisations
- [Unsuspend card token](https://modulr.readme.io/reference/unsuspendcardtoken.md): Restores a previously suspended token to active
- [Deactivate card token](https://modulr.readme.io/reference/deactivatecardtoken.md): Deactivating a token permanently disables authorisation processing. This action is irreversible
- [Download a specific card report](https://modulr.readme.io/reference/retrievepresignedreporturl.md): Download a specific card report
- [Create a new beneficiary for a specified customer](https://modulr.readme.io/reference/createbeneficiary.md): The ability to create a new beneficiary for a customer, using their customer ID as a reference.
- [Retrieve beneficiaries](https://modulr.readme.io/reference/getbeneficiaries.md): The ability to get the details of beneficiaries using various pieces of information, e.g. using customer ID, retrieve all beneficiaries created by that customer. Can get details of one particular beneficiary based on the unique beneficiary reference number.
- [Retrieve locked beneficiary entities](https://modulr.readme.io/reference/getlocks.md): Fetch references of the entities (payment, rule) that have caused the beneficiary to be locked
- [Delete beneficiaries for a specified customer](https://modulr.readme.io/reference/deletebeneficiaries.md): deleting beneficiaries for a customer, using their customer ID
- [Create an account name check](https://modulr.readme.io/reference/createoutboundcop.md): This endpoint allows you to check the account details of a payee with their bank before you create a beneficiary or payment. If the account details are confirmed, you will have greater assurance that a payment you create will reach the correct bank account. This endpoint does not support idempotent requests. Any requests containing an x-mod-nonce header used by a previous request will return the response 403: Forbidden ("Unique/allowed nonce header not found")
- [Create an account name check for Direct Debit Payer](https://modulr.readme.io/reference/createoutboundcheckforpnv.md): Payer Name Verification (PNV) automatically checks that your payer’s name matches the name on the bank account details submitted when setting up BACS Direct Debits. This reduces your exposure to fraud and failed payment setups This endpoint does not support idempotent requests. Any requests containing an x-mod-nonce header used by a previous request will return the response 403: Forbidden ("Unique/allowed nonce header not found")
- [Get SRD Accounts](https://modulr.readme.io/reference/getsrdaccounts.md): Returns a list of all sort codes and account numbers for which Secondary Reference Data must be provided with all account name check requests.
- [Create a new customer](https://modulr.readme.io/reference/createcustomer.md): This endpoint allows you to create a new customer. Creating a customer is a complex process with several dependencies, e.g: Directors, type of customer, legal specifications. For further information, please visit 'Creating a customer and account' entry on our API documentation
- [Retrieve customers using filters](https://modulr.readme.io/reference/getcustomers.md): Either using unique references, such as customer ID, or filter parameters, such as verification status, get details of any customers found.
- [Retrieve a specific customer using a unique customer reference](https://modulr.readme.io/reference/getcustomer.md): Retrieve a specific customer using a unique customer reference. This identifier can be found in the response obtained after creating a new customer, it starts by C, e.g: C0000000
- [Edit a specific customer using a unique customer reference](https://modulr.readme.io/reference/editcustomer.md): Currently editable fields: